Path hinting ...

2 years ago · 2e56f793a9
parent d6c55c076b
commit 2e56f793a9
1 changed files with 4 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -23,6 +23,10 @@ Some helpful links for RST docstring formats:
 http://daouzli.com/blog/docstring.html & 
 https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html

+The project assumes a local 'fpga' path within the home directory of the user, where all the above mentioned software packages are installed.
+Furthermore, the project assumes a virtual environment named 'fpga' where all project relevant python libs are registered (this is not strictly necessary ... maybe software/ramcreate.sh has to be adjusted, as well as the python interpreter settings within VSC!).
+The actual 'Neopixelar' project may be installed anywhere, but local paths will have to be adjusted (firmware/main.c, software/ramcreate.sh ... worx for me ;).
+
 ### 2. Hardware ###

 A JTAG programmer will be required for successful device programming. Thanx to Wolfgang, I'm using the Versaloon (s/w for blue-pill STM32), see https://github.com/zoobab/versaloon. To use this device, you also will have to install openocd via 'apt install openocd'. See https://git.hacknology.de/wolfgang/colorlight#user-content-class-hub75sender for details, on how to connect the JTAG adapter.