aboutsummaryrefslogtreecommitdiff
path: root/doc/ORGANIZATION.md
blob: a7e2020c696ca2a04c4088a34bc2a7b9b504943d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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.