From abafb6f35f717ec15edc512d3e7318d497c90dec Mon Sep 17 00:00:00 2001
From: Tristan Williams <tgwil@tgwil.net>
Date: Tue, 29 Oct 2024 10:16:34 -0400
Subject: Overhaul documentation

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 60 insertions(+), 8 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 5160417..ceb5142 100644
--- a/README.md
+++ b/README.md
@@ -7,24 +7,76 @@ It contains only the basics:
 - System/package definitions
 - Testing suite (using 5am)
 - Makefile for compiling executable
+- Documentation skeleton
 
 
 ## Usage
 
 Modify the following files:
 
-- README.md
-- Makefile
-- SYSTEM.asd
-- src/SYSTEM.lisp
-- test/SYSTEM-test.lisp
+- 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)
+- 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/`.
+- 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`).
-- 
cgit v1.2.3