Overhaul documentation

8 files changed, 195 insertions, 11 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..280e974
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# How to contribute to SYSTEM
+
+## Guidelines
+
+- Read and understand the documentation in `doc/dev/`, starting with `DEV_MANUAL.md`.
+- Make commits, branches, patches, patchsets, and emails limited to "one logical thing".
+- Follow the example of what you see in the rest of the codebase.
+- Reach out for help if you need assistance.
+
+
+## How to submit patches
+
+Email patchsets, bug reports, etc. directly to Tristan Williams <tgwil@tgwil.net> using one of the following subject templates:
+
+- Patchsets: `SYSTEM: Patchset: [description of changes]`
+- Bug Reports: `SYSTEM: Bug Report: [description of bug]`
+- Development Discussion: `SYSTEM: RFC: [description of discussion topic]`
+- Questions/Help: `SYSTEM: Help: [description of question]`
+
+Be informative in emails, but don't overwhelm with useless details.
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..e755c5e
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,7 @@
+Copyright © 2024 <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/Makefile b/Makefile
index a1fb064..5405b15 100644
--- a/Makefile
+++ b/Makefile
@@ -29,3 +29,6 @@ test:
 .PHONY: clean
 clean:
         @if test -f fash; then rm -f fash && echo "rm: SYSTEM"; fi
+
+
+# Copyright © 2024 <copyright holders>
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`).
diff --git a/SYSTEM.asd b/SYSTEM.asd
index f9b2754..1c47663 100644
--- a/SYSTEM.asd
+++ b/SYSTEM.asd
@@ -1,6 +1,5 @@
 ;;;; SYSTEM.asd
 ;;;; System definitions for SYSTEM
-;;;; AUTHOR:
 
 ;; ---------------------------------------------------------------------
 ;;; Main System Definition
@@ -18,3 +17,29 @@
   :depends-on ("SYSTEM" "fiveam")
   :components ((:file "test/SYSTEM-test"))
   :perform (asdf:test-op (o c) (uiop:symbol-call :fiveam '#:run-all-tests)))
+
+
+;; ---------------------------------------------------------------------
+;;; Copyright Notice
+;; -----------------
+;; Copyright © 2024 <copyright holders>
+;;
+;; Permission is hereby granted, free of charge, to any person obtaining
+;; a copy of this software and associated documentation files
+;; (the “Software”), to deal in the Software without restriction,
+;; including without limitation the rights to use, copy, modify, merge,
+;; publish, distribute, sublicense, and/or sell copies of the Software,
+;; and to permit persons to whom the Software is furnished to do so,
+;; subject to the following conditions:
+;;
+;; The above copyright notice and this permission notice shall be
+;; included in all copies or substantial portions of the Software.
+;;
+;; THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+;; ---------------------------------------------------------------------
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 @@
+# 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.
diff --git a/src/SYSTEM.lisp b/src/SYSTEM.lisp
index 468645a..5b30a31 100644
--- a/src/SYSTEM.lisp
+++ b/src/SYSTEM.lisp
@@ -1,6 +1,5 @@
 ;;;; SYSTEM.lisp
 ;;;; Entrypoint for SYSTEM
-;;;; AUTHOR:
 
 ;; ---------------------------------------------------------------------
 ;;; Package Definition
@@ -24,3 +23,29 @@
   "Entrypoint for SYSTEM."
   (format t "SYSTEM Version: ~A" *version*)
   "SYSTEM")
+
+
+;; ---------------------------------------------------------------------
+;;; Copyright Notice
+;; -----------------
+;; Copyright © 2024 <copyright holders>
+;;
+;; Permission is hereby granted, free of charge, to any person obtaining
+;; a copy of this software and associated documentation files
+;; (the “Software”), to deal in the Software without restriction,
+;; including without limitation the rights to use, copy, modify, merge,
+;; publish, distribute, sublicense, and/or sell copies of the Software,
+;; and to permit persons to whom the Software is furnished to do so,
+;; subject to the following conditions:
+;;
+;; The above copyright notice and this permission notice shall be
+;; included in all copies or substantial portions of the Software.
+;;
+;; THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+;; ---------------------------------------------------------------------
diff --git a/test/SYSTEM-test.lisp b/test/SYSTEM-test.lisp
index d4a69cb..2ef52c1 100644
--- a/test/SYSTEM-test.lisp
+++ b/test/SYSTEM-test.lisp
@@ -24,8 +24,33 @@
 ;; ---------------------------------------------------------------------
 ;;; Tests
 ;; ---------------------------------------------------------------------
-
 ;; Bullshit
 (5am:test existence
   "Bullshit test just for implementing tests."
   (is (equal (SYSTEM:entrypoint) "SYSTEM")))
+
+
+;; ---------------------------------------------------------------------
+;;; Copyright Notice
+;; -----------------
+;; Copyright © 2024 <copyright holders>
+;;
+;; Permission is hereby granted, free of charge, to any person obtaining
+;; a copy of this software and associated documentation files
+;; (the “Software”), to deal in the Software without restriction,
+;; including without limitation the rights to use, copy, modify, merge,
+;; publish, distribute, sublicense, and/or sell copies of the Software,
+;; and to permit persons to whom the Software is furnished to do so,
+;; subject to the following conditions:
+;;
+;; The above copyright notice and this permission notice shall be
+;; included in all copies or substantial portions of the Software.
+;;
+;; THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+;; ---------------------------------------------------------------------