diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 68 |
1 files changed, 60 insertions, 8 deletions
@@ -7,24 +7,76 @@ It contains only the basics: | |||
7 | - System/package definitions | 7 | - System/package definitions |
8 | - Testing suite (using 5am) | 8 | - Testing suite (using 5am) |
9 | - Makefile for compiling executable | 9 | - Makefile for compiling executable |
10 | - Documentation skeleton | ||
10 | 11 | ||
11 | 12 | ||
12 | ## Usage | 13 | ## Usage |
13 | 14 | ||
14 | Modify the following files: | 15 | Modify the following files: |
15 | 16 | ||
16 | - README.md | 17 | - Documentation: |
17 | - Makefile | 18 | - README.md |
18 | - SYSTEM.asd | 19 | - CONTRIBUTING.md |
19 | - src/SYSTEM.lisp | 20 | - LICENSE.txt |
20 | - test/SYSTEM-test.lisp | 21 | - doc/ORGANIZATION.md |
22 | - Build stuff: | ||
23 | - Makefile | ||
24 | - SYSTEM.asd | ||
25 | - Code files: | ||
26 | - src/SYSTEM.lisp | ||
27 | - test/SYSTEM-test.lisp | ||
21 | 28 | ||
22 | Do the following: | 29 | Do the following: |
23 | 30 | ||
24 | - Replace any instance of the word SYSTEM with the name of the system/project | 31 | - Replace any instance of the word SYSTEM with the name of the system/project. |
25 | - Fill out the headers in each file (Filename, description, AUTHOR) | 32 | - Fill out the headers in each file (Filename, description, AUTHOR). |
33 | - Delete all this template stuff in the README. | ||
34 | - [Do stuff in brackets] | ||
26 | 35 | ||
27 | 36 | ||
28 | ## Notes | 37 | ## Notes |
29 | 38 | ||
30 | - This template assumes that Quicklisp is installed to `~/lisp/quicklisp/`. | 39 | - 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. |
40 | |||
41 | |||
42 | |||
43 | |||
44 | README template follows: | ||
45 | # SYSTEM | ||
46 | |||
47 | [Description of SYSTEM]. | ||
48 | |||
49 | |||
50 | ## Current State of SYSTEM | ||
51 | |||
52 | SYSTEM is in [state]. | ||
53 | |||
54 | |||
55 | ## Installation | ||
56 | |||
57 | [How to install this thing] | ||
58 | |||
59 | |||
60 | ## Usage | ||
61 | |||
62 | [How to use this thing] | ||
63 | |||
64 | |||
65 | ## Documentation | ||
66 | |||
67 | Most documentation can be found in the `doc/` directory. | ||
68 | |||
69 | Important documentation files include: | ||
70 | - `README.md`: Documentation entrypoint. | ||
71 | - `CONTRIBUTING.md`: How to contribute to this repository. | ||
72 | - `doc/ORGANIZATION.md`: An outline of all directories/files in the repository. | ||
73 | |||
74 | |||
75 | ## Contributing to SYSTEM | ||
76 | |||
77 | Contributions are welcome. Please follow the guidelines in `CONTRIBUTING.md`. | ||
78 | |||
79 | |||
80 | ## License | ||
81 | |||
82 | This software is available under the MIT License (see `LICENSE.txt`). | ||