add README

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>

add README
Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
f7228ba7 · Federico Vaga · ba8b6dca · f7228ba7
Commit f7228ba7 authored Nov 15, 2017 by Federico Vaga
Hide whitespace changes
Inline Side-by-side

Showing with 21 additions and 0 deletions

README.rst README.rst +21 -0

No files found.
--- a/README.rst
+++ b/README.rst
+.. image:: ./doc/spec-logo.png
+
+SPEC Driver
+===========
+This is the simplified version of the SPEC driver which only purpose is
+to export an interface to enable the users to program their bitstream on
+the SPEC FPGA.
+
+Build Sources
+=============
+There are no special requirements to build the SPEC.
+
+The documentation is written in reStructuredText and it generates HTML files
+and man pages. For this you need the python docutils package installed
+
+If the requirements are satified you can run the following commant in
+the project root directory:
+
+.. code::
+
+    make