Convert *.rst back to *.md

Sphinx supports it, Hackage needs it
clash-lang · Mar 4, 2020 · 616cbe6 · 616cbe6
1 parent 3461008
commit 616cbe6
Show file tree

Hide file tree

Showing 23 changed files with 490 additions and 690 deletions.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -0,0 +1 @@
+See [GitHub contributors statistics](https://github.com/clash-lang/clash-compiler/graphs/contributors) and [clash-lang.org/publications](https://clash-lang.org/publications/).
diff --git a/AUTHORS.rst b/AUTHORS.rst
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/README.md b/README.md
@@ -0,0 +1,158 @@
+Clash - A functional hardware description language
+==================================================
+
+[![Hackage Release Version](https://img.shields.io/hackage/v/clash-ghc.svg)](https://hackage.haskell.org/package/clash-ghc)
+[![Hackage Dependency Freshness](https://img.shields.io/hackage-deps/v/clash-ghc.svg?style=flat)](https://packdeps.haskellers.com/feed?needle=exact%3Aclash-ghc)
+[![Documentation Status](https://readthedocs.org/projects/clash-lang/badge/?version=latest)](https://clash-lang.readthedocs.io/en/latest/?badge=latest)
+[![CI Pipeline Status](https://gitlab.com/clash-lang/clash-compiler/badges/master/pipeline.svg)](https://gitlab.com/clash-lang/clash-compiler/commits/master)
+
+Clash is a functional hardware description language that borrows both
+its syntax and semantics from the functional programming language
+Haskell. The Clash compiler transforms these high-level descriptions to
+low-level synthesizable VHDL, Verilog, or SystemVerilog.
+
+Features of Clash:
+
+-   Strongly typed, but with a very high degree of type inference,
+    enabling both safe and fast prototyping using concise descriptions.
+-   Interactive REPL: load your designs in an interpreter and easily
+    test all your component without needing to setup a test bench.
+-   Higher-order functions, with type inference, result in designs that
+    are fully parametric by default.
+-   Synchronous sequential circuit design based on streams of values,
+    called `Signal`s, lead to natural descriptions of feedback loops.
+-   Support for multiple clock domains, with type safe clock domain
+    crossing.
+
+Community
+=========
+
+On the World-Wide Web, there are several places of interest for Clash
+hackers:
+
+> -   [Clash Project Homepage](http://clash-lang.org)
+> -   [Clash GitHub Organization](https://github.com/clash-lang)
+> -   [Clash Google
+>     Group](https://groups.google.com/group/clash-language)
+> -   [Clash Slack
+>     Channel](https://functionalprogramming.slack.com/archives/CPGMJFF50)
+
+There are also several IRC channels on Freenode where Clash-related
+discussion may occur:
+
+`#clash-lang`
+
+:   This channel is for Clash users, and (mostly) for Clash development
+    discussion.
+
+`#haskell-embedded`
+
+:   This is a general channel for using Haskell/GHC on embedded devices.
+    While not Clash-specific, adjacent discussions and similar
+    developers may be here.
+
+Installing Clash
+================
+
+Installing via Snap
+-------------------
+
+Clash is released as a binary package on snapcraft. Snap is supported on
+all major Linux distributions. Visit [Clash’s snapcraft
+page](https://snapcraft.io/clash), scroll down, and choose your
+distribution for installation instructions. To install the latest stable
+version, use:
+
+``` {.sourceCode .bash}
+snap install clash
+```
+
+To install the latest development version of Clash, run:
+
+``` {.sourceCode .bash}
+snap install clash --edge
+```
+
+This version is updated every 24 hours.
+
+Installing via Source (Linux / MacOS)
+-------------------------------------
+
+Install the [latest nix](https://nixos.org/nix/download.html) and run:
+
+``` {.sourceCode .bash}
+curl -s -L https://github.com/clash-lang/clash-compiler/archive/1.0.tar.gz | tar xz
+nix-shell clash-compiler-1.0/shell.nix
+```
+
+See the [releases
+page](https://github.com/clash-lang/clash-compiler/releases) for all
+available versions of the compiler.
+
+Installing via Source (Windows)
+-------------------------------
+
+1.  Install [GHC
+    Platform](https://www.haskell.org/platform/windows.html). Make sure
+    to install Stack along with it.
+2.  Download the source code of [Clash
+    1.0](https://github.com/clash-lang/clash-compiler/archive/1.0.tar.gz)
+3.  Unpack the archive
+4.  Use cd to navigate to the unpacked directory
+5.  Run `stack build clash-ghc`. **This will take a while.**
+
+See the [releases
+page](https://github.com/clash-lang/clash-compiler/releases) for all
+available versions of the compiler.
+
+Installing via Source (HEAD)
+----------------------------
+
+Clone Clash from github using `git` and enter the cloned directory:
+
+``` {.sourceCode .bash}
+git clone https://github.com/clash-lang/clash-compiler.git
+cd clash-compiler
+```
+
+Use one of the build tools below to get Clash up and running.
+
+### Cabal
+
+Install Cabal &gt;= 2.4 and GHC &gt;= 8.4. Even though GHC 8.6 is
+supported, we currently recommend running 8.4 as the former contains
+some known bugs concerning documentation generation. If you’re using
+Ubuntu, add [HVR’s PPA](https://launchpad.net/~hvr/+archive/ubuntu/ghc)
+and install them using APT:
+
+``` {.sourceCode .bash}
+sudo add-apt-repository -u ppa:hvr/ghc
+sudo apt install ghc-8.4.4 cabal-install-2.4
+```
+
+Add `/opt/ghc/bin` [to your
+PATH](https://askubuntu.com/questions/60218/how-to-add-a-directory-to-the-path).
+Finally, run Clash using `cabal`:
+
+``` {.sourceCode .bash}
+cabal new-run --write-ghc-environment-files=always -- clash
+```
+
+### Stack
+
+You can use
+[Stack](https://docs.haskellstack.org/en/stable/install_and_upgrade/) to
+build and run Clash too:
+
+``` {.sourceCode .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:
+
+``` {.sourceCode .bash}
+nix-shell
+```
diff --git a/README.rst b/README.rst
diff --git a/clash-ghc/CHANGELOG.md b/clash-ghc/CHANGELOG.md
@@ -0,0 +1 @@
+../CHANGELOG.md
diff --git a/clash-ghc/CHANGELOG.rst b/clash-ghc/CHANGELOG.rst
diff --git a/clash-ghc/clash-ghc.cabal b/clash-ghc/clash-ghc.cabal
@@ -44,7 +44,7 @@ Category:             Hardware
 Build-type:           Simple
 
 Extra-source-files:   README.md,
-                      CHANGELOG.rst,
+                      CHANGELOG.md,
                       LICENSE_GHC,
                       cbits/PosixSource.h,
                       src-bin-841/Clash/GHCi/HsVersions.h

diff --git a/clash-lib/CHANGELOG.md b/clash-lib/CHANGELOG.md
@@ -0,0 +1 @@
+../CHANGELOG.md
diff --git a/clash-lib/CHANGELOG.rst b/clash-lib/CHANGELOG.rst
diff --git a/clash-lib/clash-lib.cabal b/clash-lib/clash-lib.cabal
@@ -57,7 +57,7 @@ Build-type:           Simple
 
 Extra-source-files:
   README.md,
-  CHANGELOG.rst
+  CHANGELOG.md,
   src/ClashDebug.h
 
 Data-files:

diff --git a/clash-prelude/AUTHORS.md b/clash-prelude/AUTHORS.md
@@ -0,0 +1 @@
+../AUTHORS.md
diff --git a/clash-prelude/AUTHORS.rst b/clash-prelude/AUTHORS.rst
diff --git a/clash-prelude/CHANGELOG.md b/clash-prelude/CHANGELOG.md
@@ -0,0 +1 @@
+../CHANGELOG.md
diff --git a/clash-prelude/CHANGELOG.rst b/clash-prelude/CHANGELOG.rst
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		See [GitHub contributors statistics](https://github.com/clash-lang/clash-compiler/graphs/contributors) and [clash-lang.org/publications](https://clash-lang.org/publications/).