Skip to content

Commit a681b4b

Browse files
committed
Added instructions for runnning MSYS2 through Command Prompt
1 parent 3856f3f commit a681b4b

File tree

1 file changed

+36
-7
lines changed

1 file changed

+36
-7
lines changed

src/murfey/templates/bootstrap.html

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -107,30 +107,56 @@ <h4>C. Configuring the Rust Package Manager (If Network-Restricted)</h4>
107107
then be pasted in a <span style="font-family: monospace">.cargo</span> folder,
108108
which, by default, shold be located in your User Profile homespace:
109109
</p>
110-
<pre style="font-family: monospace">%USERPROFILE%\.cargo</pre>
110+
<pre style="font-family: monospace">
111+
%USERPROFILE%\.cargo
112+
</pre>
111113
<p>For a user named Murfey, for example, this would take the form:</p>
112-
<pre style="font-family: monospace">C:\Users\Murfey\.cargo</pre>
114+
<pre style="font-family: monospace">
115+
C:\Users\Murfey\.cargo
116+
</pre>
113117
<p>
114118
With this file configured,
115119
<span style="font-family: monospace">cargo</span> will know to look for
116120
package metadata and files via the Murfey mirror instead.
117121
</p>
118122

123+
<h4>D. Running MSYS2 Through Command Prompt</h4>
124+
<p>
125+
In order to run Murfey via the terminal, MSYS2 will have to be run through
126+
Windoww's Command Prompt terminal, as there is an ongoing bug with MSYS2's
127+
pre-packaged terminal that prevents mouse interaction with interactive apps in
128+
the terminal.
129+
</p>
130+
<p>
131+
To do so, simply right-click on your desktop and navigate to
132+
<span>New > Shortcut</span>. When prompted for the location of the item, enter
133+
the following into the text box:
134+
</p>
135+
<pre style="font-family: monospace">
136+
cmd.exe /k "C:\msys64\msys2_shell.cmd -defterm -no-start -ucrt64 -shell bash"
137+
</pre>
138+
<p>
139+
After naming the shortcut, click Finish to create the shortcut. This will run
140+
a UCRT64 instance of MSYS2 through the Command Prompt terminal that starts you
141+
off in MSYS2's default home directory. You can proceed to customise the
142+
shortcut icon to taste.
143+
</p>
144+
119145
<h2>2. Setting Up Python</h2>
120146
<p>
121147
Once Python and pip are installed in the terminal, you have the option to
122148
install Murfey in either the base environment or a virtual environment. The
123149
base environment is simpler, but uninstallation of the Python packages in the
124150
future could potentially interfere with the base environment's functionality.
125151
</p>
126-
<h3>Setting Up a Virtual Environment</h3>
152+
<h3>A. (Optional) Setting Up a Virtual Environment</h3>
127153
<p>To set up a virtual environment, run the following commands:</p>
128154
<pre style="font-family: monospace">
129155
$ pip install virtualenv --index-url {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/pypi --trusted-host {{ netloc }}
130156
$ virtualenv your-env-name # Create the virtual environment
131157
$ source your-env-name/bin/activate # Activate the virtual environment
132158
</pre>
133-
<h3>Installing Murfey</h3>
159+
<h3>B. Installing Murfey</h3>
134160
<p>
135161
You can install Murfey in the Python environment (the base one or a virtual
136162
environment) in either the Cygwin or UCRT64 terminal using the following
@@ -139,7 +165,10 @@ <h3>Installing Murfey</h3>
139165
<pre style="font-family: monospace">
140166
$ pip install murfey[client] --index-url {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/pypi --trusted-host {{ netloc }}
141167
</pre>
142-
<pre>
143-
If you wish to install the client-side dependencies needed to run Murfey via the web UI, replace <span style="font-family: monospace;">murfey[client]</span> with <span style="font-family: monospace;">murfey[client,instrument-server]</span>.
144-
</pre>
168+
<p>
169+
If you wish to install the client-side dependencies needed to run Murfey via
170+
the web UI, replace
171+
<span style="font-family: monospace">murfey[client]</span> with
172+
<span style="font-family: monospace">murfey[client,instrument-server]</span>.
173+
</p>
145174
{% endblock %}

0 commit comments

Comments
 (0)