diff options
| author | Tristan Williams <tgwil@tgwil.net> | 2024-10-29 10:16:34 -0400 |
|---|---|---|
| committer | Tristan Williams <tgwil@tgwil.net> | 2024-10-29 10:16:34 -0400 |
| commit | abafb6f35f717ec15edc512d3e7318d497c90dec (patch) | |
| tree | b5647300656578be064fbbaffc0b7bc0ba5e76f2 /doc/ORGANIZATION.md | |
| parent | Rename old thing to SYSTEM (diff) | |
| download | template.cl-abafb6f35f717ec15edc512d3e7318d497c90dec.tar.gz template.cl-abafb6f35f717ec15edc512d3e7318d497c90dec.tar.bz2 template.cl-abafb6f35f717ec15edc512d3e7318d497c90dec.zip | |
Overhaul documentation
Diffstat (limited to 'doc/ORGANIZATION.md')
| -rw-r--r-- | doc/ORGANIZATION.md | 27 |
1 files changed, 27 insertions, 0 deletions
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 @@ | |||
| 1 | # Organization of SYSTEM repository | ||
| 2 | |||
| 3 | ## Directories/Files and their purposes | ||
| 4 | |||
| 5 | ### Documentation | ||
| 6 | |||
| 7 | - `README.md`: Entrypoint for documentation. Should be the first thing everyone reads. | ||
| 8 | |||
| 9 | - `CONTRIBUTING.md`: Guidelines for contributing to this project. | ||
| 10 | |||
| 11 | - `LICENSE.txt`: Copy of license text. | ||
| 12 | |||
| 13 | - `doc/`: Documentation. | ||
| 14 | - `doc/ORGANIZATION.md`: This file. Outline of repository and the purpose of everything in it. | ||
| 15 | |||
| 16 | |||
| 17 | ### Source Code | ||
| 18 | |||
| 19 | - `Makefile`: Make script for compiling executable. | ||
| 20 | |||
| 21 | - `SYSTEM.asd`: Lisp system definition. | ||
| 22 | |||
| 23 | - `src/`: Source Code. | ||
| 24 | - `src/SYSTEM.lisp`: Lisp package definition, entrypoint for application. | ||
| 25 | |||
| 26 | - `test/`: Test Suite. | ||
| 27 | - `test/SYSTEM-test.lisp`: Entrypoint for test suite. | ||