diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..9748b75 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,11 @@ +## The doc/ directory + The `doc/` directory serves as home for documentation. This is the place to + put refined documentation after it has gone through `notes/`. The contents of + this directory should be accessible to a broad audience including prospective + users, active users, and developers. Highly technical + + 1. The note authors and + 2. Developers of the project + + It need not be meaningful to casual users. + diff --git a/notes/README.md b/notes/README.md new file mode 100644 index 0000000..5ded349 --- /dev/null +++ b/notes/README.md @@ -0,0 +1,9 @@ +## The notes/ directory + The `notes/` directory serves as staging directory for documentation. This is + the place to develop documentation and short notes. The contents of this + directory should be accessible to + 1. The note authors and + 2. Developers of the project + + It need not be meaningful to casual users. +