diff --git a/contrib/td-env.sh b/contrib/td-env.sh deleted file mode 100644 index 5ec7340..0000000 --- a/contrib/td-env.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env sh - -alias td="sh make.sh" diff --git a/site/index.html b/site/index.html index fdfaf60..31f25cd 100644 --- a/site/index.html +++ b/site/index.html @@ -247,13 +247,18 @@ POSIX base utilities, including find, stat,
-$ ./make.sh +$ . 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 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

@@ -538,14 +543,16 @@ but the preferred way is to check out the source code from CVS. This makes generating patches a lot easier.

-$ export CVSROOT=anoncvs@bancino.net:/cvs -$ cvs checkout Telodendria +$ cvs -d anoncvs@bancino.net:/cvs checkout -P Telodendria $ cd Telodendria

-There is no password for the anoncvs account. It should -just let you fetch the source code without having to input a password. +If you already checkout out the code previously, make sure you update your +local copy before you start developing:

+
+$ cvs -q update -P +

You should now have the latest Telodendria source code. Follow the Code Style as you make your changes. @@ -600,10 +607,10 @@ 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 is not only +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 build Telodendria. +the only supported way to develop Telodendria.

I opted to write a custom build script instead of just using @@ -625,17 +632,20 @@ on the command line. To start using it, just run the following command in your Telodendria directory:

-$ . contrib/td-env.sh +$ . tools/env.sh

Note: You will have to run the above command every time you -start a new terminal session, as nothing is persisted. +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, which td will include -automatically for you. For the best experience, you'll want at -least these values: +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 @@ -674,15 +684,7 @@ $ td patch

This will automatically generate a patch file for all your changes, -and then open it in your default editor. You can set the -EDITOR variable to your preferred editor if the default -doesn't work for you. Either set it in your environment via your -preferred means, or set it like this: -

-
-$ EDITOR=gedit td patch -
-

+and then open it in your preferred editor. You can also generate a patch for only certain files and directories. To do that, set PATCHSET, like this:

@@ -691,12 +693,6 @@ To do that, set PATCHSET, like this: $ PATCHSET="README.txt site/" td patch

-You can of course specify both PATCHSET and -EDITOR at the same time, if you want. But at that point, -it might make more sense to just EDITOR in your -.env or in your system environment. -

-

As you'll notice, the top of the patch file should have some email-style headers that look like this: