diff options
author | Yann Herklotz <ymherklotz@gmail.com> | 2019-01-19 13:09:59 +0000 |
---|---|---|
committer | Yann Herklotz <ymherklotz@gmail.com> | 2019-01-19 13:09:59 +0000 |
commit | 9b881b23ecc7f9f7aee5b067674099c2fff51d5b (patch) | |
tree | 951c12ee5ada1f2a358772f1b10704de00f553de | |
parent | ef96fa6692c15d71ce98983434e50591e897ca2b (diff) | |
download | verismith-9b881b23ecc7f9f7aee5b067674099c2fff51d5b.tar.gz verismith-9b881b23ecc7f9f7aee5b067674099c2fff51d5b.zip |
Add some documentation to main README
-rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
@@ -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 +``` |