summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathanael Sensfelder <SpamShield0@MultiAgentSystems.org>2017-08-16 11:29:47 +0200
committerNathanael Sensfelder <SpamShield0@MultiAgentSystems.org>2017-08-16 11:29:47 +0200
commit079e885a348c56eee5adeb3ff2dc7925697d33fb (patch)
treeaf36825bcb34f19a24efd7898d783b1cfeafe7b2
parent10e7fc528c0a767da2f7b8447b6c62d017adaf54 (diff)
Improves Phrasing, changes to match new Makefiles.
-rw-r--r--README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.md b/README.md
index 2479f31..1ed2e4e 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# Tabellion
-Reports groups of elements from the VHDL code according to logic formulas.
+Reports groups of elements from VHDL code according to logic formulas.
This can be used, for example, to check if coding rules have been followed, or
to confirm that a group of elements are indeed what their creator intended them
@@ -10,11 +10,10 @@ operators) is used to write the formulas.
## Warning
The use of this tool for anything other than its development is currently not
-recommended, as this is an early prototype and it likely contains many bugs.
+recommended. Indeed, this is an early prototype: not only is it not feature
+complete, but it is also likely to contain many bugs.
## Getting Started
-Here is a small guide on how to get the software running.
-
Tabellion is composed of multiple sub-programs:
* A VHDL to AST translation program, not yet available, so GHDL is used instead.
* A model generator, ``ast-to-instr``, which populates predicates according to
@@ -22,15 +21,19 @@ the AST.
* Solvers, which handle the validation of properties for the aforementioned
model, ``instr-to-kodkod`` is currently the only solver available.
* Solution printers, which convert the results of the solver to a specific
-format (none available yet).
+format (sol-pretty-printer is the only one available at the moment).
### Prerequisites
* GHDL
* Java
* make
+Additionally, ``instr-to-kodkod`` uses Kodkod, ANTLR, and Sat4j. Those will be
+downloaded automatically by ``instr-to-kodkod`` and kept into its folder.
+
### How to Use
1. Clone the repository.
-3. Use ``make run`` to automatically fetch missing jars, compile everything and
+2. Use ``make`` to automatically fetch missing jars, compile everything and
launch the current configuration (which is found in the ``Makefile``). The use
-of parallel processing is recommended (e.g. ``make run -j14``).
+of parallel processing is strongly recommended (e.g. ``make -j14`` to run 14
+parallel jobs).