blob: ceb5142f87cc853b26ecfeb4d0620981ae4d082e (
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
# Template.CommonLisp
This is a template for Common Lisp systems.
It contains only the basics:
- System/package definitions
- Testing suite (using 5am)
- Makefile for compiling executable
- Documentation skeleton
## Usage
Modify the following files:
- Documentation:
- README.md
- CONTRIBUTING.md
- LICENSE.txt
- doc/ORGANIZATION.md
- Build stuff:
- Makefile
- SYSTEM.asd
- Code files:
- src/SYSTEM.lisp
- test/SYSTEM-test.lisp
Do the following:
- Replace any instance of the word SYSTEM with the name of the system/project.
- Fill out the headers in each file (Filename, description, AUTHOR).
- Delete all this template stuff in the README.
- [Do stuff in brackets]
## Notes
- This template assumes that Quicklisp is installed to `~/lisp/quicklisp/`. If it is not, you need to update the `Makefile` to load Quicklisp from wherever you have it installed.
README template follows:
# SYSTEM
[Description of SYSTEM].
## Current State of SYSTEM
SYSTEM is in [state].
## Installation
[How to install this thing]
## Usage
[How to use this thing]
## Documentation
Most documentation can be found in the `doc/` directory.
Important documentation files include:
- `README.md`: Documentation entrypoint.
- `CONTRIBUTING.md`: How to contribute to this repository.
- `doc/ORGANIZATION.md`: An outline of all directories/files in the repository.
## Contributing to SYSTEM
Contributions are welcome. Please follow the guidelines in `CONTRIBUTING.md`.
## License
This software is available under the MIT License (see `LICENSE.txt`).
|