diff --git a/README.md b/README.md new file mode 100644 index 00000000..2527812b --- /dev/null +++ b/README.md @@ -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