Update README

Now that the project contains both HDL and software the README needs an update. I just wrote few lines here because the plan is to have a proper documentation in doc/. Signed-off-by: Federico Vaga <federico.vaga@cern.ch>

Update README
Now that the project contains both HDL and software the README needs an update. I just wrote few lines here because the plan is to have a proper documentation in doc/. Signed-off-by: Federico Vaga <federico.vaga@cern.ch>
58729a7f · Federico Vaga · 96a9e065 · 58729a7f
Commit 58729a7f authored Jul 18, 2019 by Federico Vaga
Hide whitespace changes
Inline Side-by-side

Showing with 5 additions and 20 deletions

README.rst README.rst +5 -20

No files found.
--- a/README.rst
+++ b/README.rst
-.. image:: ./doc/spec-logo.png
+==============================
+Simple PCIe FMC Carrier - SPEC
+==============================

-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
+This git repository contains the HDL code necessary to enable most of
+the SPEC features and the correspondent Linux driver.