Merge pull request #1 from clash-lang/initial-cleanup

Initial cleanup

Author: hydrolarus

.gitignore

@@ -0,0 +1 @@
+/public/

compiler-userguide/src/SUMMARY.md

@@ -4,7 +4,6 @@
 
 - [Getting Started]()
     - [Installing](./getting-started/installing.md)
-    - [First Circuit](./getting-started/first-circuit.md)
 - [General](./general/index.md)
     - [Release Notes](./general/relnotes.md)
     - [FAQs](./general/faqs.md)
@@ -14,5 +13,3 @@
     - [Prelude](./developing-hardware/prelude.md)
     - [Flags](./developing-hardware/flags.md)
 - [Hacking on Clash](./hacking-on-clash/index.md)
-    - [Style](./hacking-on-clash/style.md)
-- [References](./refs.md)

compiler-userguide/src/getting-started/first-circuit.md

@@ -2,71 +2,3 @@
 
 Check out [clash-lang.org/install](https://clash-lang.org/install) to
 install the latest stable release of Clash, or to setup a Clash project.
-
-## Get Clash from source
-
-Get the source code using
-[Git](https://git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F) and
-enter the cloned directory:
-
-``` bash
-git clone git@github.com:clash-lang/clash-compiler.git
-
-# Alternatively, if you haven't setup SSH keys with GitHub:
-# git clone https://github.com/clash-lang/clash-compiler.git
-
-cd clash-compiler
-```
-
-To check out a released version, use:
-
-``` bash
-git checkout v1.2.3
-```
-
-To checkout a release *branch* use:
-
-``` bash
-git checkout 1.2
-```
-
-Note that release branches might contain non-released patches.
-
-### Cabal
-
-To use Cabal you need both Cabal and GHC installed on your system. For
-Linux and MacOS users we recommend using
-[ghcup](https://www.haskell.org/ghcup/). Windows users are recommended
-to use the [Haskell
-Platform](https://www.haskell.org/platform/windows.html).
-
-To run <span class="title-ref">clash</span> use:
-
-``` bash
-cabal v2-run --write-ghc-environment-files=always -- clash
-```
-
-If this fails, make sure you've got an up-to-date package index:
-
-``` bash
-cabal update
-```
-
-### Stack
-
-[Install
-Stack](https://docs.haskellstack.org/en/stable/install_and_upgrade/) and
-run:
-
-``` bash
-stack run -- clash
-```
-
-### Nix
-
-Or [use Nix](https://nixos.org/nix/download.html) to get a shell with
-the `clash` and `clashi` binaries on your PATH:
-
-``` bash
-nix-shell
-```

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

@@ -15,6 +15,73 @@ backend being tested. This means you need
   [Z3](https://github.com/Z3Prover/z3) installed to test *Verilog* and
   *System Verilog*
 
+## Get Clash from source
+
+Get the source code using
+[Git](https://git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F) and
+enter the cloned directory:
+
+``` bash
+git clone git@github.com:clash-lang/clash-compiler.git
+
+# Alternatively, if you haven't setup SSH keys with GitHub:
+# git clone https://github.com/clash-lang/clash-compiler.git
+
+cd clash-compiler
+```
+
+To check out a released version, use:
+
+``` bash
+git checkout v1.2.3
+```
+
+To checkout a release *branch* use:
+
+``` bash
+git checkout 1.2
+```
+
+Note that release branches might contain non-released patches.
+
+### Cabal
+
+To use Cabal you need both Cabal and GHC installed on your system. For
+Linux and MacOS users we recommend using
+[ghcup](https://www.haskell.org/ghcup/). Windows users are recommended
+to use the [Haskell
+Platform](https://www.haskell.org/platform/windows.html).
+
+To run <span class="title-ref">clash</span> use:
+
+``` bash
+cabal v2-run --write-ghc-environment-files=always -- clash
+```
+
+If this fails, make sure you've got an up-to-date package index:
+
+``` bash
+cabal update
+```
+
+### Stack
+
+[Install
+Stack](https://docs.haskellstack.org/en/stable/install_and_upgrade/) and
+run:
+
+``` bash
+stack run -- clash
+```
+
+### Nix
+
+Or [use Nix](https://nixos.org/nix/download.html) to get a shell with
+the `clash` and `clashi` binaries on your PATH:
+
+``` bash
+nix-shell
+```
 ## Subprojects
 
 The Clash compiler consists of different cabal libraries, which together