forked from Telodendria/Telodendria
Add repository structure documentation.
This commit is contained in:
parent
f6c54cbc7f
commit
7033a1f0b1
3 changed files with 18 additions and 64 deletions
64
README.txt
64
README.txt
|
@ -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
|
|
||||||
|
|
|
@ -15,6 +15,7 @@ issue, and, even better, a pull request to fix the issue.
|
||||||
|
|
||||||
## Developer Documentation
|
## Developer Documentation
|
||||||
|
|
||||||
|
- [Repository Structure](dev/repo.md)
|
||||||
- [Contributing Guidelines](CONTRIBUTING.md)
|
- [Contributing Guidelines](CONTRIBUTING.md)
|
||||||
- [Porting Guidelines](dev/ports.md)
|
- [Porting Guidelines](dev/ports.md)
|
||||||
|
|
||||||
|
|
17
docs/dev/repo.md
Normal file
17
docs/dev/repo.md
Normal file
|
@ -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.
|
||||||
|
|
Loading…
Reference in a new issue