Skip to content

Commit 296315d

Browse files
authored
Merge pull request #618 from herbie-fp/install-and-docker-documentation
Install and docker documentation
2 parents ef3fecd + 6d56c54 commit 296315d

File tree

1 file changed

+30
-21
lines changed

1 file changed

+30
-21
lines changed

www/doc/1.7/installing.html

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ <h1>Installing Herbie</h1>
2323
</header>
2424

2525
<p>
26-
<a href="../../">Herbie</a> supports Linux, macOS, and Windows. It
26+
<a href="../../">Herbie</a> supports Linux, macOS, and Windows
27+
(though, on Windows, you will need to <a href="https://stackoverflow.com/questions/32127524/how-to-install-and-use-make-in-windows">install Make</a>). It
2728
can be installed from a package or from source. To start, install
2829
<a href="https://racket-lang.org">Racket</a>, which Herbie is
2930
written in. Install <a href="https://www.rust-lang.org/">Rust</a>
@@ -35,27 +36,34 @@ <h2>Installing Racket</h2>
3536

3637
<p>
3738
Install Racket either using
38-
the <a href="http://download.racket-lang.org/racket-v8.5.html">official
39-
installer</a> or distro-provided packages. Versions as old as 8.0
39+
the <a href="http://download.racket-lang.org/racket-v8.9.html">official
40+
installer</a> or distro-provided packages. Versions as old as 8.0
4041
are supported, but more recent versions are faster.
4142
</p>
4243

44+
<p>
45+
Please note: we recommend the official Racket installer over installing Racket via Snap.
46+
If you must install Racket from Snap, make sure Herbie and all packages are
47+
located in your home directory or another allow-listed directory.
48+
</p>
49+
4350
<p>
4451
Test that Racket is installed correctly and has a correct version:
4552
</p>
4653

4754
<pre class="shell">racket
48-
Welcome to Racket v8.5 [cs].
55+
Welcome to Racket v8.9 [cs].
4956
> (exit)</pre>
5057

51-
<h2>Installing Herbie from source</h2>
58+
<h2>Installing Herbie from source</h2>
5259

5360
<p>
5461
Install Rust, using <a href="https://rustup.rs/">rustup</a> or via some other means.
5562
Versions as old as 1.60.0 are supported.
56-
This installation method supports Windows, macOS, and Linux for various architectures.
63+
This installation method supports Windows (note that you will need some way to run make),
64+
macOS, and Linux for various architectures.
5765
</p>
58-
66+
5967
<p>
6068
Once Racket and Rust are installed, download the Herbie source
6169
<a href="https://github.com/uwplse/herbie">from GitHub</a> with:
@@ -75,43 +83,44 @@ <h2>Installing Herbie from source</h2>
7583
<p>
7684
This command installs Herbie and its dependencies, compiles it for
7785
faster startup, and places the <code>herbie</code> executable in
78-
your Racket user path (example paths for Racket 8.5):
86+
your Racket user path (example paths for Racket 8.9):
7987
</p>
8088

8189
<ul>
82-
<li>On Windows, <code>AppData\Roaming\Racket\8.5\bin</code> in your user folder.</li>
83-
<li>On macOS, <code>Library/Racket/8.5/bin</code> in your home folder.</li>
84-
<li>On Linux, <code>.local/share/racket/8.5/bin</code> in your home directory.</li>
90+
<li>On Windows, <code>AppData\Roaming\Racket\8.9\bin</code> in your user folder.</li>
91+
<li>On macOS, <code>Library/Racket/8.9/bin</code> in your home folder.</li>
92+
<li>On Linux, <code>.local/share/racket/8.9/bin</code> in your home directory.</li>
8593
</ul>
8694

8795
<p>
88-
You can run <code>herbie</code> from that directory, or add it to
89-
your executable path. Once Herbie is installed and working
96+
Please note that the path of the binary will be different on Linux if you
97+
have opted to use Snap. You can run <code>herbie</code> from that directory,
98+
or add it to your executable path. Once Herbie is installed and working
9099
correctly, check out the <a href="tutorial.html">tutorial</a>.
91100
</p>
92101

93102
<h2>Installing Herbie from a package</h2>
94103

95104
<p>
96-
This installation method supports Windows, macOS, and Linux for x86-64.
97-
This method of installation will fail for Apple M1 systems and other ARM architectures.
98-
Once Racket is installed, install Herbie from a package with:
105+
This installation method supports Windows ((note that you will need some way to run make),
106+
macOS, and Linux for x86-64. This method of installation will fail for Apple M1 systems
107+
and other ARM architectures. Once Racket is installed, install Herbie from a package with:
99108
</p>
100109

101-
<pre class="shell">raco pkg install --auto herbie</pre>
110+
<pre class="shell">raco pkg install --auto herbie</pre>
102111

103112
<!-- This is a copy of the text above -->
104113

105114
<p>
106115
This command installs Herbie and its dependencies, compiles it for
107116
faster startup, and places the <code>herbie</code> executable in
108-
your Racket user path (example paths for Racket 8.1):
117+
your Racket user path (example paths for Racket 8.9):
109118
</p>
110119

111120
<ul>
112-
<li>On Windows, <code>AppData\Roaming\Racket\8.5\bin</code> in your user folder.</li>
113-
<li>On macOS, <code>Library/Racket/8.5/bin</code> in your home folder.</li>
114-
<li>On Linux, <code>.local/share/racket/8.5/bin</code> in your home directory.</li>
121+
<li>On Windows, <code>AppData\Roaming\Racket\8.9\bin</code> in your user folder.</li>
122+
<li>On macOS, <code>Library/Racket/8.9/bin</code> in your home folder.</li>
123+
<li>On Linux, <code>.local/share/racket/8.9/bin</code> in your home directory.</li>
115124
</ul>
116125

117126
<p>

0 commit comments

Comments
 (0)