diff --git a/site/index.html b/site/index.html index 8474b73..371dfe2 100644 --- a/site/index.html +++ b/site/index.html @@ -213,52 +213,20 @@ information.

You can check out the change log here.

-

Building The Source

+

Documentation

-Telodendria is designed to be light enough that it can be built -from source on just about any operating system. It only has the -following requirements, all of which should be already available to -you on a sufficiently complete operating system: +Telodendria's documentation is distributed with the source +code as man pages, which contain all of the information +on how to build the source, configure it, as well as contribute to +the project. The man pages are also available online +for convenience:

-
-$ . tools/env.sh -$ td build -
-

-If everything went well, that will produce build/telodendria, -which you can then place wherever you want, and run as a system daemon. -See the contrib folder for configuration examples. -

-

-If you're going to be doing more than just building the code, see -The Build Script for full documentation on -what the td script can do. -

Configure Telodendria

Telodendria is designed to be extremely configurable. As such, it has @@ -848,183 +816,6 @@ that I should run indent(1) on the code after applying it. I'll likely run my indent(1) on the code anyway though, just to make sure the spacing is consistent, if nothing else.

-

The Build Script

-

-Telodendria uses a custom build script called td, -for Telodendria developer. The td script is not only -a build script, however. It does all kinds of cool things like -format the source code, and generate patch files. td is -the only supported way to develop Telodendria. -

-

-I opted to write a custom build script instead of just using -make, because I felt that there is really no way to make -a truly portable Makefile that could do everything I -need. I was doing a lot of research on the differences between the -GNU and BSD versions of make, and I felt it just wasn't -worth it when I could write a small POSIX script that would run on -both GNU systems and BSD systems without a fuss. -

-

-The td script is fairly intuitive. It operates somewhat -like make, in that it has recipes that you specify -on the command line. To start using it, just run the following -command in your Telodendria directory: -

-
-$ . tools/env.sh -
-

-Note: You will have to run the above command every time you -start a new terminal session, as nothing is persisted to your system. -I believe in non-invasive, fully self-contained tooling, so it is up to -you to hook the Telodendria tools into your environment if you want them -to persist. -

-

-If you're going to be submitting patches, you should also configure -a .env file in the project directory root, which -td will include automatically for you. For the best -experience, you'll want at least these values: -

-
-MXID=@your:matrix-id.net -DISPLAY_NAME="Your Display Name" -EDITOR=gedit # Or whatever your preferred editor is. -
-

-If you don't provide these values, td will deduce them -from your environment. It uses your system username and hostname to -create the MXID, and reads the password database to -get your configured display name. It also uses vi as -the default editor, which may not be suitable for all developers. -

-

-You can invoke td recipes with the following syntax: -

-
-$ td <recipe> ... -
-

-Multiple recipes can be invoked in a single run of td. -At the moment, recipes are run unconditionally; that is, even if parts -of a recipe fail, all following recipes still run. -

-

-Here is a complete list of recipes currently supported by -td, and a description of what they do. Some recipes can -alter their behavior based on certain environment variables. Those -variables are also documented here. -

- -

-Any environment variables noted above that td recipes -use can be specified in a .env file in the root of the -Telodendria directory. This saves you from constantly -having to set the environment variables in your shell, as well as -from having to pollute your user environment with Telodendria -variables. td will automatically include the -.env file on every run. -

-
-td will source the .env file, which means -it executes it like a shell script. Any shell code inside of -.env will be executed every time td is -run. -

Submitting Patches

Telodendria aims at remaining as minimal as possible. This doesn't @@ -1144,59 +935,6 @@ send a message. You're always welcome to inquire about rejected patches, and request they be reviewed again, or you can use them as a starting point for future patches.

-

License

-

-All of the code for Telodendria is licensed under a modified -MIT license. Please consult the src/header.txt file for -the actual license text. The Telodendria license text differs -from the MIT license in the following ways: -

- -

-The documentation for Telodendria is also licensed under the -modified MIT license that lives in src/header.txt. Whether -you obtain the documentation by printing, or otherwise downloading -this page, or by checking it out from the CVS source, it is licensed -the same as the code. -

-The Telodendria logo, however, belongs solely to the -Telodendria project. It must only be used to represent the -official Telodendria project, and may only appear in official -Telodendria media. If Telodendria is forked, the logo -must be removed from the project and optionally replaced by a different -one. The logo may not be modified in any way or for any purpose. -

-

Contributors

-

-Telodendria would not be possible without the support of the -following people: -

- -

Change Log

-

-At this time, Telodendria does not have any tagged releases because it -is not yet functional as a Matrix homeserver. Please check out the Project Status to see where things are -currently at. -

Resources