Skip to content

Commit 4e18198

Browse files
[skip-ci] Update installation instructions in tutorial
1 parent 8e0dd58 commit 4e18198

File tree

1 file changed

+3
-80
lines changed

1 file changed

+3
-80
lines changed

clash-prelude/src/Clash/Tutorial.hs

Lines changed: 3 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ module Clash.Tutorial (
1212
-- * Introduction
1313
-- $introduction
1414

15-
-- * Installation
15+
-- * Install Clash
1616
-- $installation
1717

1818
-- * Working with this tutorial
@@ -213,84 +213,7 @@ our first circuit.
213213
-}
214214

215215
{- $installation
216-
The Clash compiler and Prelude library for circuit design only work with the
217-
<http://haskell.org/ghc GHC> Haskell compiler version 8.2.1 or higher.
218-
219-
(1) Install __GHC 8.2.1 or higher__
220-
221-
* Download and install <https://www.haskell.org/ghc/download_ghc_8_4_3 GHC for your platform>.
222-
Unix user can use @./configure prefix=\<LOCATION\>@ to set the installation
223-
location.
224-
225-
* Make sure that the @bin@ directory of __GHC__ is in your @PATH@.
226-
227-
In case you cannot find what you are looking for on <https://www.haskell.org/ghc/download_ghc_8_4_3>,
228-
you can, /alternatively/, use the following instructions:
229-
230-
* Ubuntu:
231-
232-
* Run: @sudo add-apt-repository -y ppa:hvr/ghc@
233-
* Run: @sudo apt-get update@
234-
* Run: @sudo apt-get install cabal-install-2.2 ghc-8.4.3 libtinfo-dev@
235-
* Update your @PATH@ with: @\/opt\/ghc\/bin@, @\/opt\/cabal\/bin@, and @\$HOME\/.cabal\/bin@
236-
* Run: @cabal update@
237-
* Skip step 2.
238-
239-
* OS X:
240-
241-
* Follow the instructions on: <https://www.haskell.org/platform/mac.html Haskell Platform Mac OS X>
242-
to install the /minimal/ Haskell platform
243-
* Run: @cabal update@
244-
* Skip step 2.
245-
246-
* Windows:
247-
248-
* Follow the instructions on: <https://www.haskell.org/platform/windows.html Haskell Platform Windows>
249-
to install the /minimal/ Haskell platform
250-
* Run: @cabal update@
251-
* Skip step 2.
252-
253-
(2) Install __Cabal (version 2.2 or higher)__
254-
255-
* Binary, when available:
256-
257-
* Download the binary for <http://www.haskell.org/cabal/download.html cabal-install>
258-
* Put the binary in a location mentioned in your @PATH@
259-
* Add @cabal@'s @bin@ directory to your @PATH@:
260-
261-
* Windows: @%appdata%\\cabal\\bin@
262-
* Unix: @\$HOME\/.cabal\/bin@
263-
264-
* Source:
265-
266-
* Download the sources for <http://hackage.haskell.org/package/cabal-install cabal-install>
267-
* Unpack (@tar xf@) the archive and @cd@ to the directory
268-
* Run: @sh bootstrap.sh@
269-
* Follow the instructions to add @cabal@ to your @PATH@
270-
271-
* Run @cabal update@
272-
273-
(2) Install __Clash__
274-
275-
* Run:
276-
277-
* Linux: @cabal install clash-ghc --enable-documentation --enable-executable-dynamic@
278-
* Other: @cabal install clash-ghc --enable-documentation@
279-
280-
* /This is going to take awhile, so have a refreshment/
281-
282-
(4) Verify that everything is working by:
283-
284-
* Downloading the <https://raw.githubusercontent.com/clash-lang/clash-compiler/36a60d7979012b39bcaac66ec7048a7ec7167fbe/examples/FIR.hs Fir.hs> example
285-
* Run: @clashi FIR.hs@
286-
* Execute, in the interpreter, the @:vhdl@ command
287-
* Execute, in the interpreter, the @:verilog@ command
288-
* Execute, in the interpreter, the @:systemverilog@ command
289-
* Exit the interpreter using @:q@
290-
* Examine the VHDL code in the @vhdl@ directory
291-
* Examine the Verilog code in the @verilog@ directory
292-
* Examine the SystemVerilog code in the @systemverilog@ directory
293-
216+
For installation instructions, see <https://clash-lang.org/install/ clash-lang.org/install/>.
294217
-}
295218

296219
{- $working
@@ -299,7 +222,7 @@ at the same time. If you followed the installation instructions, you already
299222
know how to start the Clash compiler in interpretive mode:
300223
301224
@
302-
clashi
225+
clash.clashi # When installed from source, use 'clashi'
303226
@
304227
305228
For those familiar with Haskell/GHC, this is indeed just @GHCi@, with three

0 commit comments

Comments
 (0)