From abafb6f35f717ec15edc512d3e7318d497c90dec Mon Sep 17 00:00:00 2001 From: Tristan Williams Date: Tue, 29 Oct 2024 10:16:34 -0400 Subject: Overhaul documentation --- doc/ORGANIZATION.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 doc/ORGANIZATION.md (limited to 'doc') diff --git a/doc/ORGANIZATION.md b/doc/ORGANIZATION.md new file mode 100644 index 0000000..a7e2020 --- /dev/null +++ b/doc/ORGANIZATION.md @@ -0,0 +1,27 @@ +# Organization of SYSTEM repository + +## Directories/Files and their purposes + +### Documentation + +- `README.md`: Entrypoint for documentation. Should be the first thing everyone reads. + +- `CONTRIBUTING.md`: Guidelines for contributing to this project. + +- `LICENSE.txt`: Copy of license text. + +- `doc/`: Documentation. + - `doc/ORGANIZATION.md`: This file. Outline of repository and the purpose of everything in it. + + +### Source Code + +- `Makefile`: Make script for compiling executable. + +- `SYSTEM.asd`: Lisp system definition. + +- `src/`: Source Code. + - `src/SYSTEM.lisp`: Lisp package definition, entrypoint for application. + +- `test/`: Test Suite. + - `test/SYSTEM-test.lisp`: Entrypoint for test suite. -- cgit v1.2.3