magical
/
ttbp
forked from endorphant/ttbp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updating docs

master
endorphant 2016-09-08 19:02:56 -04:00
parent 718308ea55
commit d83df0f370
2 changed files with 70 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.html
View File

@ -3,12 +3,42 @@
<p><code>ttbp</code> stands for &ldquo;tilde.town blogging platform&rdquo;, the original working name for <p><code>ttbp</code> stands for &ldquo;tilde.town blogging platform&rdquo;, the original working name for
this project.</p> this project.</p>
<p><img src="http://tilde.town/~endorphant/ttbp/screenshots/ttbp-main.png" alt="ttbp main menu screenshot" /></p>
<p><img src="http://tilde.town/~endorphant/ttbp/screenshots/ttbp-entries.png" alt="ttbp entries view screenshot" /></p>
<p><img src="http://tilde.town/~endorphant/ttbp/screenshots/ttbp-compose.png" alt="ttbp compose view screenshot" /></p>
<p><code>ttbp</code> runs from the command line, providing a hub for writing personal blog
posts and reading posts written by other users of tilde.town. it&rsquo;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.</p>
<p>to use, run <code>~endorphant/bin/ttbp</code> while logged in to tilde.town</p> <p>to use, run <code>~endorphant/bin/ttbp</code> while logged in to tilde.town</p>
<p>you can also try <code>~endorphant/bin/ttbp-beta</code> for a more colorful, but <p>you can also try <code>~endorphant/bin/ttbp-beta</code> for a more colorful, but
potentially volatile experience; i sometimes announce in irc or on twitter when potentially volatile experience; i sometimes announce in irc or on twitter when
i&rsquo;m testing a new feature.</p> i&rsquo;m testing a new feature.</p>
<h3>QUICK START</h3>
<p>no coding or html experience is necessary to get started. just log in to your
tilde.town account and enter:</p>
<p><code>~endorphant/bin/ttbp</code></p>
<p>ttbp will ask you a few questions to get you started. after that, writing and
reading entries all happen within the program.</p>
<p>that&rsquo;s it!</p>
<h3>SUPPORT</h3>
<p>if you&rsquo;re having trouble getting started, or run into program errors or strange
behavior, please send internal tilde.town mail to ~endorphant and i&rsquo;ll try to
sort things out!</p>
<h3>writing entries</h3> <h3>writing entries</h3>
<p>entries are recorded as plaintext files in your ~/.ttbp/entries <p>entries are recorded as plaintext files in your ~/.ttbp/entries
@ -89,14 +119,6 @@ your local timezone yet. here are some
</ul> </ul>
<h3>dependencies</h3>
<ul>
<li><a href="https://pypi.python.org/pypi/mistune">mistune</a></li>
<li><a href="https://pypi.python.org/pypi/inflect">inflect</a></li>
</ul>
<h3>future features</h3> <h3>future features</h3>
<p>these are a few ideas being kicked around, or under active development:</p> <p>these are a few ideas being kicked around, or under active development:</p>
@ -109,3 +131,20 @@ your local timezone yet. here are some
<li>better entry display within ttbp</li> <li>better entry display within ttbp</li>
</ul> </ul>
<h3>dependencies</h3>
<p>(this section is only relevant if you plan on forking the repo and running an
instance of this yourself)</p>
<ul>
<li><a href="https://pypi.python.org/pypi/mistune">mistune</a></li>
<li><a href="https://pypi.python.org/pypi/inflect">inflect</a></li>
</ul>
<h3>contributing</h3>
<p>if you&rsquo;re interested in helping with the code, please drop me some tildemail!</p>
<p>unsolicited pull requests for bug-swatting are greatly appreciated.</p>

28
README.md
View File

@ -3,6 +3,12 @@
`ttbp` stands for "tilde.town blogging platform", the original working name for `ttbp` stands for "tilde.town blogging platform", the original working name for
this project. 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 `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 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 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 no coding or html experience is necessary to get started. just log in to your
tilde.town account and enter: tilde.town account and enter:
`~endorphant/bin/ttbp` `~endorphant/bin/ttbp`
ttbp will ask you a few questions to get you started. after that, writing and ttbp will ask you a few questions to get you started. after that, writing and
reading entries all happen within the program. reading entries all happen within the program.
that's it!
### SUPPORT ### SUPPORT
if you're having trouble getting started, or run into program errors or strange 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 your local timezone yet. here are some
[timezone setting instructions](http://www.cyberciti.biz/faq/linux-unix-set-tz-environment-variable/) [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 ### future features
these are a few ideas being kicked around, or under active development: 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 * responding to entries
* paginated list view * paginated list view
* better entry display within ttbp * 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.