From 7033a1f0b14c541d0fef565aa52f59063a4d4c1d Mon Sep 17 00:00:00 2001 From: Jordan Bancino Date: Fri, 8 Sep 2023 12:12:07 -0400 Subject: [PATCH] Add repository structure documentation. --- README.txt | 64 ------------------------------------------------ docs/README.md | 1 + docs/dev/repo.md | 17 +++++++++++++ 3 files changed, 18 insertions(+), 64 deletions(-) delete mode 100644 README.txt create mode 100644 docs/dev/repo.md diff --git a/README.txt b/README.txt deleted file mode 100644 index a580af8..0000000 --- a/README.txt +++ /dev/null @@ -1,64 +0,0 @@ - .= -=- - :.:+ .=:. - .=+-==. :. - .+- =. - .+ :+. - ==. -+: - =++==--:: =+. - .:::--=+=: :+= - :==. -=: - ===----=-. ... :+. - :==+=======: .-+-::-+-=+= - .==*%#======= :+- .. - .:--=-===+=========-. :+: - .=++=::..:============-+=-=- -:+=: :=+-: .-=========-. . - =+++: .:=+-: .:--. .--:==: - ::---:.. :=+: == - ++. .+- - =+ .+- ...: - +- -+-:-+=::+: - :=-....:-=: .--: =- - -++=:.:::.. - -======================================================= -|_ _|__| | ___ __| | ___ _ __ __| |_ __(_) __ _ - | |/ _ \ |/ _ \ / _` |/ _ \ '_ \ / _` | '__| |/ _` | - | | __/ | (_) | (_| | __/ | | | (_| | | | | (_| | - |_|\___|_|\___/ \__,_|\___|_| |_|\__,_|_| |_|\__,_| -======================================================= -Copyright (C) 2023 Jordan Bancino <@jordan:bancino.net> - -This is the source code for Telodendria, a Matrix homeserver written -in C. All of the documentation is available as man pages in the -man/ directory, or online at https://telodendria.io - -If information is missing from the documentation, please feel free -to reach out to #telodendria-general:bancino.net on Matrix. - -This file documents the directory structure of the source code -repository. - -Telodendria/ - contrib/ - Supplemental files, such as example configs. - man/ - The official documentation as man pages. - proposals/ - Proposals for new features or fixes, as man pages. - site/ - The official website. - src/ - The C source code for Telodendria. - include/ - Header files for the source code. - Routes/ - Where Matrix API endpoints are implemented. - Static/ - Endpoints that just generate static HTML pages. - tests/ - Unit and integration tests will eventually go here. - tools/ - Development environment and tools. - -To cut a new release for Telodendria, perform the following -steps. This is just a reference for me so I don't mess it up. - - - Update tools/bin/td to declare the next version number. - - Make sure man/man7/telodendria-changelog.7 is up to date. - with the latest information. (Be sure to set the date - correctly) - - Commit all changes. - - Run the release recipe: td release - - Deploy the site: td site - diff --git a/docs/README.md b/docs/README.md index 801b57d..248f5fe 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,6 +15,7 @@ issue, and, even better, a pull request to fix the issue. ## Developer Documentation +- [Repository Structure](dev/repo.md) - [Contributing Guidelines](CONTRIBUTING.md) - [Porting Guidelines](dev/ports.md) diff --git a/docs/dev/repo.md b/docs/dev/repo.md new file mode 100644 index 0000000..c77fac4 --- /dev/null +++ b/docs/dev/repo.md @@ -0,0 +1,17 @@ +# Repository Structure + +This document describes the filesystem layout of the Telodendria source +code repository. + +- `Telodendria/` + - `Cytoplasm/`: The source code for Cytoplasm, Telodendria's + general-purpose support library that provides core functionality. + - `contrib/`: Supplemental files, such as example configurations. + - `docs/`: All user and developer documentation as Markdown. + - `site/`: The official website source code as HTML. + - `src/': The C source code and headers for Telodendria. + - `Routes/`: Where the Matrix API endpoints are implemented. + - `Static/`: Endpoints that just generate static HTML pages. + - `include/`: Header files. + - `tools/`: Development environment and tools. +