Skip to content

Commit bd17f3c

Browse files
Installing from git: part of Hacking on Clash chapter
No changes, just a move. The text can probably use some work. We shouldn't overload our users with information in the Getting started section.
1 parent 3ee700a commit bd17f3c

File tree

2 files changed

+67
-68
lines changed

2 files changed

+67
-68
lines changed

compiler-userguide/src/getting-started/installing.md

Lines changed: 0 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -2,71 +2,3 @@
22

33
Check out [clash-lang.org/install](https://clash-lang.org/install) to
44
install the latest stable release of Clash, or to setup a Clash project.
5-
6-
## Get Clash from source
7-
8-
Get the source code using
9-
[Git](https://git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F) and
10-
enter the cloned directory:
11-
12-
``` bash
13-
git clone git@github.com:clash-lang/clash-compiler.git
14-
15-
# Alternatively, if you haven't setup SSH keys with GitHub:
16-
# git clone https://github.com/clash-lang/clash-compiler.git
17-
18-
cd clash-compiler
19-
```
20-
21-
To check out a released version, use:
22-
23-
``` bash
24-
git checkout v1.2.3
25-
```
26-
27-
To checkout a release *branch* use:
28-
29-
``` bash
30-
git checkout 1.2
31-
```
32-
33-
Note that release branches might contain non-released patches.
34-
35-
### Cabal
36-
37-
To use Cabal you need both Cabal and GHC installed on your system. For
38-
Linux and MacOS users we recommend using
39-
[ghcup](https://www.haskell.org/ghcup/). Windows users are recommended
40-
to use the [Haskell
41-
Platform](https://www.haskell.org/platform/windows.html).
42-
43-
To run <span class="title-ref">clash</span> use:
44-
45-
``` bash
46-
cabal v2-run --write-ghc-environment-files=always -- clash
47-
```
48-
49-
If this fails, make sure you've got an up-to-date package index:
50-
51-
``` bash
52-
cabal update
53-
```
54-
55-
### Stack
56-
57-
[Install
58-
Stack](https://docs.haskellstack.org/en/stable/install_and_upgrade/) and
59-
run:
60-
61-
``` bash
62-
stack run -- clash
63-
```
64-
65-
### Nix
66-
67-
Or [use Nix](https://nixos.org/nix/download.html) to get a shell with
68-
the `clash` and `clashi` binaries on your PATH:
69-
70-
``` bash
71-
nix-shell
72-
```

compiler-userguide/src/hacking-on-clash/index.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,73 @@ backend being tested. This means you need
1515
[Z3](https://github.com/Z3Prover/z3) installed to test *Verilog* and
1616
*System Verilog*
1717

18+
## Get Clash from source
19+
20+
Get the source code using
21+
[Git](https://git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F) and
22+
enter the cloned directory:
23+
24+
``` bash
25+
git clone git@github.com:clash-lang/clash-compiler.git
26+
27+
# Alternatively, if you haven't setup SSH keys with GitHub:
28+
# git clone https://github.com/clash-lang/clash-compiler.git
29+
30+
cd clash-compiler
31+
```
32+
33+
To check out a released version, use:
34+
35+
``` bash
36+
git checkout v1.2.3
37+
```
38+
39+
To checkout a release *branch* use:
40+
41+
``` bash
42+
git checkout 1.2
43+
```
44+
45+
Note that release branches might contain non-released patches.
46+
47+
### Cabal
48+
49+
To use Cabal you need both Cabal and GHC installed on your system. For
50+
Linux and MacOS users we recommend using
51+
[ghcup](https://www.haskell.org/ghcup/). Windows users are recommended
52+
to use the [Haskell
53+
Platform](https://www.haskell.org/platform/windows.html).
54+
55+
To run <span class="title-ref">clash</span> use:
56+
57+
``` bash
58+
cabal v2-run --write-ghc-environment-files=always -- clash
59+
```
60+
61+
If this fails, make sure you've got an up-to-date package index:
62+
63+
``` bash
64+
cabal update
65+
```
66+
67+
### Stack
68+
69+
[Install
70+
Stack](https://docs.haskellstack.org/en/stable/install_and_upgrade/) and
71+
run:
72+
73+
``` bash
74+
stack run -- clash
75+
```
76+
77+
### Nix
78+
79+
Or [use Nix](https://nixos.org/nix/download.html) to get a shell with
80+
the `clash` and `clashi` binaries on your PATH:
81+
82+
``` bash
83+
nix-shell
84+
```
1885
## Subprojects
1986

2087
The Clash compiler consists of different cabal libraries, which together

0 commit comments

Comments
 (0)