Lab_NHMFL
/
upsilon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docker documentation

This commit is contained in:
Peter McGoron 2023-06-20 13:23:43 -04:00
parent 93d9349430
commit dc1e8bae8c
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/docker.md
View File

@ -1,5 +1,10 @@
Upsilon docker development environment setup. Upsilon docker development environment setup.
# Dockerfile style guide
Dockerfiles should be simple. The Dockerfiles should be readable to a
beginner.
# Setup steps # Setup steps
Change directory to `build`. Change directory to `build`.

10
doc/verilog_manual.md
View File

@ -194,7 +194,7 @@ information, you can look at
This isn't used for this project but it really should. This isn't used for this project but it really should.
# LiteX # LiteX and F4PGA
LiteX is a System on a Chip builder written in Python. It easily integrates LiteX is a System on a Chip builder written in Python. It easily integrates
Verilog modules and large system components (CPU, RAM, Ethernet) into Verilog modules and large system components (CPU, RAM, Ethernet) into
@ -207,6 +207,14 @@ by modifying the `Base` and the `UpsilonSoC` class.
All the code that you need to understand in `soc.py` is heavily documented. All the code that you need to understand in `soc.py` is heavily documented.
(If it's not, that means I don't understand it.) (If it's not, that means I don't understand it.)
F4PGA is an open source synthesis suite. LiteX handles F4PGA for you (most of
the time).
You should use the Dockerfiles included with upsilon. They are simple and are
pinned to the latest known stable version that can build Upsilon. If you really
want to install LiteX and F4PGA to your system, just follow the commands in
the docker files.
# Workarounds and Hacks # Workarounds and Hacks
## LiteX Compile Times Take Too Long for Testing ## LiteX Compile Times Take Too Long for Testing