Create README.md

Signed-off-by: Clifford Wolf <clifford@clifford.at>
Signed-off-by: Tim 'mithro' Ansell <mithro@mithis.com>
This commit is contained in:
Clifford Wolf 2017-10-17 23:45:27 +02:00 committed by Tim 'mithro' Ansell
parent 16584e8fa4
commit b800d548eb
1 changed files with 23 additions and 0 deletions

23
README.md Normal file
View File

@ -0,0 +1,23 @@
Project X-Ray
=============
Documenting the Xilinx 7-series bit-stream format.
Quickstart Guide:
-----------------
Always make sure to set the environment for the device you are working on before
running any other commands:
source database/artix7/settings.sh
Creating HTML documentation:
cd htmlgen
python3 htmlgen
(Re-)creating parts of the database, for example LUT init bits:
cd fuzzers/010-lutinit
make
make pushdb