Skip to content

Commit 9ea4921

Browse files
authored
Forgot to push last commit (#559)
* Addressed typos; rearranged sections to emphasise MSYS2 as recommended POSIX environment to use
1 parent d8a5133 commit 9ea4921

File tree

1 file changed

+51
-46
lines changed

1 file changed

+51
-46
lines changed

src/murfey/templates/bootstrap.html

Lines changed: 51 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,11 @@
1-
{% extends "base.html" %} {% block title %}Bootstrapping instructions{% endblock
1+
{% extends "base.html" %} {% block title %}Bootstrapping Instructions{% endblock
22
%} {% block content %}
3-
<h1>Bootstrapping instructions</h1>
3+
<h1>Bootstrapping Instructions</h1>
44
<h2>1. Setting Up a POSIX Environment</h2>
5-
<h3>Option 1: Installing Cygwin</h3>
5+
<h3>A. Installing MSYS2 (Recommended)</h3>
66
<p>
7-
Cygwin is a lightweight POSIX environment that provides the minimum
8-
requirements needed for a Windows client PC to efficiently transfer files to a
9-
Unix storage server. However, it currently does not support building and
10-
installing packages which have been written in Rust, which many modern Python
11-
packages, including Murfey's dependencies, now make use of. Nevertheless,
12-
older versions of Murfey will still work with it.
13-
</p>
14-
<p>
15-
To install, download the Cygwin setup executable using this
16-
<a href="{{ proxy_path }}/cygwin/setup-x86_64.exe">mirror</a>, and then run
17-
the following from a terminal (both Command Prompt and Windows Powershell
18-
work):
19-
</p>
20-
<pre
21-
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
22-
>
23-
$ setup-x86_64.exe -O -R C:\cygwin64 -s {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/cygwin -P curl,python3,rsync -q
24-
</pre>
25-
<p>
26-
This will install Cygwin with the minimum packages needed to run Murfey. The
27-
Cygwin install command will occasionally hang after completion. In such an
28-
event, just hit Enter to return to a normal command prompt window.
29-
</p>
30-
<p>
31-
If you already have a Cygwin install that you would like to preserve, rename
32-
it so that it doesn't get overwritten (something like "cygwin64-old") before
33-
running the command line above.
34-
</p>
35-
36-
<h3>Option 2: Installing MSYS2</h3>
37-
<p>
38-
MSYS2 is a lightweight POSIX environment which provides compiler support for
39-
the more modern programming languages used by Murfey's package dependencies.
7+
MSYS2 is a POSIX environment which provides extensive compiler support for the
8+
more modern programming languages used by Murfey's package dependencies.
409
</p>
4110
<p>
4211
The Murfey server supports the forwarding of download requests to
@@ -47,7 +16,7 @@ <h3>Option 2: Installing MSYS2</h3>
4716
>, then run it using the default settings. This will install MSYS2 to
4817
C:\msys64.
4918
</p>
50-
<h4>A. Setting Up the Package Manager (If Network-Restricted)</h4>
19+
<h4>Setting Up the MSYS2 Package Manager (If Network-Restricted)</h4>
5120
<p>
5221
By default, MSYS2 comes with preset lists of mirrors and servers that it
5322
installs its packages from. On a network-restricted PC, these will need to be
@@ -67,7 +36,7 @@ <h4>A. Setting Up the Package Manager (If Network-Restricted)</h4>
6736
>
6837
C:\msys64\etc\pacman.d
6938
</pre>
70-
<h4>B. Installing Dependencies</h4>
39+
<h4>Installing Dependencies</h4>
7140
<p>
7241
MSYS2 comes with multiple environments, but UCRT64 is the most modern one. In
7342
order for the Murfey client to be able to install and run its dependencies
@@ -100,7 +69,7 @@ <h4>B. Installing Dependencies</h4>
10069
>pacman -Ss &lt;package-name&gt;</span
10170
>
10271
</p>
103-
<h4>C. Configuring the Rust Package Manager (If Network-Restricted)</h4>
72+
<h4>Configuring the Rust Package Manager (If Network-Restricted)</h4>
10473
<p>
10574
Many newer Python packages now have dependencies written in Rust that allow
10675
them to operate more efficiently. MSYS2 supports the compilation and
@@ -140,7 +109,7 @@ <h4>C. Configuring the Rust Package Manager (If Network-Restricted)</h4>
140109
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
141110
>.cargo</span
142111
>
143-
folder, which, by default, shold be located in your User Profile homespace:
112+
folder, which, by default, should be located in your User Profile homespace:
144113
</p>
145114
<pre
146115
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
@@ -163,10 +132,10 @@ <h4>C. Configuring the Rust Package Manager (If Network-Restricted)</h4>
163132
instead.
164133
</p>
165134

166-
<h4>D. Running MSYS2 Through Command Prompt</h4>
135+
<h4>Running MSYS2 Through Command Prompt</h4>
167136
<p>
168137
In order to run Murfey via the terminal, MSYS2 will have to be run through
169-
Windoww's Command Prompt terminal, as there is an ongoing bug with MSYS2's
138+
Window's Command Prompt terminal, as there is an ongoing bug with MSYS2's
170139
pre-packaged terminal that prevents mouse interaction with interactive apps in
171140
the terminal.
172141
</p>
@@ -187,12 +156,48 @@ <h4>D. Running MSYS2 Through Command Prompt</h4>
187156
shortcut icon to taste.
188157
</p>
189158

159+
<h3>B. Installing Cygwin (Legacy)</h3>
160+
<p>
161+
Cygwin is a lightweight POSIX environment that provides the minimum
162+
requirements needed for a Windows client PC to run Murfey . However, it does
163+
not support building and installing packages which have been written in Rust,
164+
which many modern Python packages, including Murfey's dependencies, now make
165+
use of. It is still possible to install and run Murfey via Cygwin, but older
166+
versions of its dependencies will have to be installed.
167+
</p>
168+
<p>
169+
To install, download the Cygwin setup executable using this
170+
<a href="{{ proxy_path }}/cygwin/setup-x86_64.exe">mirror</a>, and then run
171+
the following from a terminal (both Command Prompt and Windows Powershell
172+
work):
173+
</p>
174+
<pre
175+
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
176+
>
177+
$ setup-x86_64.exe -O -R C:\cygwin64 -s {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/cygwin -P curl,python3,rsync -q
178+
</pre>
179+
<p>
180+
This will install Cygwin with the minimum packages needed to run Murfey. The
181+
Cygwin install command will occasionally hang after completion. In such an
182+
event, just hit Enter to return to a normal command prompt window.
183+
</p>
184+
<p>
185+
If you already have a Cygwin install that you would like to preserve, rename
186+
it so that it doesn't get overwritten (something like "cygwin64-old") before
187+
running the command line above.
188+
</p>
189+
190190
<h2>2. Setting Up Python</h2>
191191
<p>
192-
Once Python and pip are installed in the terminal, you have the option to
193-
install Murfey in either the base environment or a virtual environment. The
194-
base environment is simpler, but uninstallation of the Python packages in the
195-
future could potentially interfere with the base environment's functionality.
192+
Once Python and
193+
<span
194+
style="font-family: Consolas, Monaco, &quot;Lucida Console&quot;, monospace"
195+
>pip</span
196+
>
197+
are installed in the terminal, you have the option to install Murfey in either
198+
the base environment or a virtual environment. The base environment is
199+
simpler, but uninstallation of the Python packages in the future could
200+
potentially interfere with the base environment's functionality.
196201
</p>
197202
<h3>A. (Optional) Setting Up a Virtual Environment</h3>
198203
<p>To set up a virtual environment, run the following commands:</p>

0 commit comments

Comments
 (0)