From c6b4c3ad76ec6d1514d0df08c61d7398a1b5622c Mon Sep 17 00:00:00 2001 From: Jordan Bancino Date: Tue, 1 Nov 2022 16:29:31 -0400 Subject: [PATCH] Make the READMEs a little more descriptive. I need something to test git cvsimport with, too. --- README.md | 5 +++-- README.txt | 12 ++++++++++++ 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d6e3334..496e04a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # [Telodendria](https://telodendria.io) -## Submit Patches To [#telodendria-patches:bancino.net](https://matrix.to/#/#telodendria-patches:bancino.net) On Matrix +**Telodendria** is an open source Matrix homeserver implementation written from scratch in ANSI C and designed to be lightweight and simple, yet functional. -This project is not developed on GitHub. As such, pull requests are not accepted. You're more than welcome to clone this repo and use Git to make your changes, but when it comes time to submit changes to this project, use [git format-patch](https://git-scm.com/docs/git-format-patch). +**Important:** This project is not developed on GitHub, or even with Git. As such, GitHub Pull Requests are not accepted. But that doesn't mean we don't want your contribution! You're more than welcome to clone this repo and use Git to make changes to the project if you'd prefer it to CVS, but when it comes time to actually submit your changes to this project, use [git format-patch](https://git-scm.com/docs/git-format-patch) to generate patch files, then submit them to the official Matrix room: [#telodendria-patches:bancino.net](https://matrix.to/#/#telodendria-patches:bancino.net). +Please see the `README.txt` file for the actual project `README`, which simply details the repository structure a little bit. All of **Telodendria**'s user and developer documentation is available as `man` pages, or online. diff --git a/README.txt b/README.txt index 08d310f..be0ae57 100644 --- a/README.txt +++ b/README.txt @@ -13,3 +13,15 @@ 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. + 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 + tests/ - Unit and integration tests will eventually go here. + tools/ - Development environment and tools.