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

move organization.md to README.md

This commit is contained in:
Peter McGoron 2023-06-27 13:24:26 -04:00
parent 130e1775ac
commit 291329b49e
2 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,8 +1,21 @@
# upsilon
Upsilon is a 100% free and open source STM/AFM controller for FPGAs running
Linux.
Linux. Read `doc/copying/README.md` for license information.
## License
## Quickstart
See `copying` folder for more information.
Read `doc/copying/docker.md` to set up the Docker build environment.
## Project Organization
* `boot/`: This folder is the central place for all built files. This
includes the kernel image, rootfs, gateware, etc. This directory also
includes everything the TFTP server has to access.
* `build/`: Docker build environment.
* `buildroot/`: Buildroot configuration files.
* `doc/`: Documentation.
* `doc/copying`: Licenses.
* `gateware/`: FPGA source.
* `linux/`: Software that runs on the controller.
* `opensbi/`: OpenSBI configuration files and source fragments.

10
doc/organization.md
View File

@ -1,10 +0,0 @@
* `boot/`: This folder is the central place for all built files. This
includes the kernel image, rootfs, gateware, etc. This directory also
includes everything the TFTP server has to access.
* `build/`: Docker build environment.
* `buildroot/`: Buildroot configuration files.
* `doc/`: Documentation.
* `doc/copying`: Licenses.
* `gateware/`: FPGA source.
* `linux/`: Software that runs on the controller.
* `opensbi/`: OpenSBI configuration files and source fragments.