From 9b881b23ecc7f9f7aee5b067674099c2fff51d5b Mon Sep 17 00:00:00 2001
From: Yann Herklotz <ymherklotz@gmail.com>
Date: Sat, 19 Jan 2019 13:09:59 +0000
Subject: Add some documentation to main README

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 15fc288..8c52d8c 100644
--- a/README.md
+++ b/README.md
@@ -8,3 +8,42 @@ It currently supports the following simulators:
 - [Yosys](http://www.clifford.at/yosys/)
 - [Icarus Verilog](http://iverilog.icarus.com)
 - [Xst](https://www.xilinx.com/support/documentation/sw_manuals/xilinx11/ise_c_using_xst_for_synthesis.htm)
+
+## Build the Fuzzer
+
+The fuzzer is split into an executable (in the [`app`](/app) folder) and a
+library (in the [`src`](/src) folder). To build the executable, you will need
+[stack](https://docs.haskellstack.org/en/stable/README/) installed. Building
+directly using [cabal-install](https://www.haskell.org/cabal/download.html) is
+possible but not recommended and not directly supported.
+
+To build the executable
+
+``` shell
+stack build
+```
+
+To run the executable
+
+``` shell
+stack exec verifuzz
+```
+
+To install the executable (which defaults to installing it in `~/.local`)
+
+``` shell
+stack install
+```
+
+## Running tests
+
+There are two test-suites that currently test the library. One of the
+test-suites tests the random code generation and generation of the acyclic
+graph. It also contains some property based tests for this. The other test-suite
+uses `doctest` to test the examples that are in the documentation.
+
+To run the test-suites
+
+``` shell
+stack test
+```
-- 
cgit