From 68b8f5b6ab7edd5cae2f16fbc114a0b89c8f2e00 Mon Sep 17 00:00:00 2001 From: endorphant Date: Sun, 22 May 2016 01:52:29 -0400 Subject: [PATCH] directory reorg --- LICENSE. txt => LICENSE | 0 README.html | 98 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+) rename LICENSE. txt => LICENSE (100%) create mode 100644 README.html diff --git a/LICENSE. txt b/LICENSE similarity index 100% rename from LICENSE. txt rename to LICENSE diff --git a/README.html b/README.html new file mode 100644 index 0000000..946e87b --- /dev/null +++ b/README.html @@ -0,0 +1,98 @@ +

a command-line based blogging platform running on tilde.town

+ +

ttbp stands for “tilde.town blogging platform”, the original working name for +this project.

+ +

to use, run ~endorphant/bin/ttbp while logged in to tilde.town

+ +

you can also try ~endorphant/bin/ttbp-beta for a more unstable, bleeding-edge +experience.

+ +

writing entries

+ +

entries are recorded as plaintext files in your ~/.ttbp/entries +directory. you can edit them there directly, or fix old entries, or +delete entries.

+ +

warning: changing old entries might cause strange things to +happen with timestamps. the main program looks at the filename +first for setting the date, then the last modified time to sort +recent posts. it expects YYYMMDD.txt as the filename; anything else +won’t show up as a valid entry. yes, this means you can post things out +of date order by creating files with any date you want.

+ +

general entry-writing notes

+ + + + +

privacy

+ +

when you start your ttbp, you have the option of publishing or not publishing +your blog.

+ +

if you opt to publish, the program creates a directory ~/.ttbp/www +where it stores all html files it generates, and symlinks this from your +~/public_html with your chosen blog directory. your blog will also be listed +on the main ttbp page.

+ +

if you opt to not publish, your entires will never be accessible from outside +of the tilde.town network; other tilde.town users will still be able to read +your entries through the ttbp interface, or by directly accessing your +~/.ttbp/entries directory.

+ +

if you want to further protect your entries, you can chmod 700 your entries +directory.

+ +

changing your page layout

+ +

you can modify how your blog looks by editing the stylesheet or +header and footer files. the program sets you up with basic +default. if you break your page somehow, you can force the program to +regenerate your configuration by deleting your ~/.ttbp directory entirely. +you might want to back up your ~/.ttbp/entries directory before you do +this.

+ + + + +

general tips

+ + + + +

future features

+ +

these are a few ideas being kicked around, or under active development:

+ + +