diff --git a/README.html b/README.html index 04b5fc6..4996a88 100644 --- a/README.html +++ b/README.html @@ -3,12 +3,42 @@

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

+

ttbp main menu screenshot

+ +

ttbp entries view screenshot

+ +

ttbp compose view screenshot

+ +

ttbp runs from the command line, providing a hub for writing personal blog +posts and reading posts written by other users of tilde.town. it’s a little bit +like livejournal or dreamwidth or tumblr. you can opt to publish your posts to +a public html file hosted on your tilde page, or keep all your entries private +to the tilde.town server.

+

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

you can also try ~endorphant/bin/ttbp-beta for a more colorful, but potentially volatile experience; i sometimes announce in irc or on twitter when i’m testing a new feature.

+

QUICK START

+ +

no coding or html experience is necessary to get started. just log in to your +tilde.town account and enter:

+ +

~endorphant/bin/ttbp

+ +

ttbp will ask you a few questions to get you started. after that, writing and +reading entries all happen within the program.

+ +

that’s it!

+ +

SUPPORT

+ +

if you’re having trouble getting started, or run into program errors or strange +behavior, please send internal tilde.town mail to ~endorphant and i’ll try to +sort things out!

+

writing entries

entries are recorded as plaintext files in your ~/.ttbp/entries @@ -89,14 +119,6 @@ your local timezone yet. here are some -

dependencies

- - - -

future features

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

@@ -109,3 +131,20 @@ your local timezone yet. here are some
  • better entry display within ttbp
  • + +

    dependencies

    + +

    (this section is only relevant if you plan on forking the repo and running an +instance of this yourself)

    + + + + +

    contributing

    + +

    if you’re interested in helping with the code, please drop me some tildemail!

    + +

    unsolicited pull requests for bug-swatting are greatly appreciated.

    diff --git a/README.md b/README.md index 6696f4d..aacd843 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ `ttbp` stands for "tilde.town blogging platform", the original working name for this project. +![ttbp main menu screenshot](http://tilde.town/~endorphant/ttbp/screenshots/ttbp-main.png) + +![ttbp entries view screenshot](http://tilde.town/~endorphant/ttbp/screenshots/ttbp-entries.png) + +![ttbp compose view screenshot](http://tilde.town/~endorphant/ttbp/screenshots/ttbp-compose.png) + `ttbp` runs from the command line, providing a hub for writing personal blog posts and reading posts written by other users of tilde.town. it's a little bit like livejournal or dreamwidth or tumblr. you can opt to publish your posts to @@ -19,11 +25,14 @@ i'm testing a new feature. no coding or html experience is necessary to get started. just log in to your tilde.town account and enter: + `~endorphant/bin/ttbp` ttbp will ask you a few questions to get you started. after that, writing and reading entries all happen within the program. +that's it! + ### SUPPORT if you're having trouble getting started, or run into program errors or strange @@ -93,11 +102,6 @@ this.** your local timezone yet. here are some [timezone setting instructions](http://www.cyberciti.biz/faq/linux-unix-set-tz-environment-variable/) -### dependencies - -* [mistune](https://pypi.python.org/pypi/mistune) -* [inflect](https://pypi.python.org/pypi/inflect) - ### future features these are a few ideas being kicked around, or under active development: @@ -107,3 +111,17 @@ these are a few ideas being kicked around, or under active development: * responding to entries * paginated list view * better entry display within ttbp + +### dependencies + +(this section is only relevant if you plan on forking the repo and running an +instance of this yourself) + +* [mistune](https://pypi.python.org/pypi/mistune) +* [inflect](https://pypi.python.org/pypi/inflect) + +### contributing + +if you're interested in helping with the code, please drop me some tildemail! + +unsolicited pull requests for bug-swatting are greatly appreciated.