Telodendria/README.txt

65 lines
2.9 KiB
Text
Raw Permalink Normal View History

2022-12-13 17:09:05 +00:00
.= -=-
:.:+ .=:.
.=+-==. :.
.+- =.
.+ :+.
==. -+:
=++==--:: =+.
.:::--=+=: :+=
:==. -=:
===----=-. ... :+.
:==+=======: .-+-::-+-=+=
.==*%#======= :+- ..
.:--=-===+=========-. :+:
.=++=::..:============-+=-=-
:+=: :=+-: .-=========-. .
=+++: .:=+-: .:--. .--:==:
::---:.. :=+: ==
++. .+-
=+ .+- ...:
+- -+-:-+=::+:
:=-....:-=: .--: =-
-++=:.:::..
2022-07-29 20:06:01 +00:00
=======================================================
|_ _|__| | ___ __| | ___ _ __ __| |_ __(_) __ _
| |/ _ \ |/ _ \ / _` |/ _ \ '_ \ / _` | '__| |/ _` |
| | __/ | (_) | (_| | __/ | | | (_| | | | | (_| |
|_|\___|_|\___/ \__,_|\___|_| |_|\__,_|_| |_|\__,_|
=======================================================
2023-03-07 00:44:53 +00:00
Copyright (C) 2023 Jordan Bancino <@jordan:bancino.net>
This is the source code for Telodendria, a Matrix homeserver written
2022-09-22 13:47:52 +00:00
in C. All of the documentation is available as man pages in the
2022-10-13 01:25:59 +00:00
man/ directory, or online at https://telodendria.io
2022-07-29 20:06:01 +00:00
2022-09-22 13:47:52 +00:00
If information is missing from the documentation, please feel free
to reach out to #telodendria-general:bancino.net on Matrix.
2022-07-29 20:06:01 +00:00
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.
2023-03-07 00:44:53 +00:00
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.
2023-03-07 00:44:53 +00:00
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.
2022-12-13 17:09:05 +00:00
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.
2023-03-07 00:50:59 +00:00
with the latest information. (Be sure to set the date
correctly)
- Commit all changes.
2022-12-13 17:09:05 +00:00
- Run the release recipe: td release
- Deploy the site: td site