diff --git a/README.md b/README.md index bf5cf01..0df0d92 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/doc/organization.md b/doc/organization.md deleted file mode 100644 index 2ed7cc0..0000000 --- a/doc/organization.md +++ /dev/null @@ -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.