diff --git a/README.html b/README.html index 4996a88..7e4a1d9 100644 --- a/README.html +++ b/README.html @@ -1,6 +1,6 @@
a command-line based blogging platform running on tilde.town
-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.
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
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
to use, run feels
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.
(feels
is a tilde.town specific command; if you're running this locally, or on
+a different server, run ttbp
from the command line)
no coding or html experience is necessary to get started. just log in to your tilde.town account and enter:
-~endorphant/bin/ttbp
feels
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!
+that's it!
-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 +
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!
-entries are recorded as plaintext files in your ~/.ttbp/entries directory. you can edit them there directly, or fix old entries, or @@ -49,21 +48,22 @@ delete entries.
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 +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. -<!-- comments -->
to have them show up
in the feed but not render in a browser (but people can still read
them with view-source)when you start your ttbp, you have the option of publishing or not publishing your blog.
@@ -81,7 +81,7 @@ your entries through the ttbp interface, or by directly accessing yourif you want to further protect your entries, you can chmod 700
your entries
directory.
you can modify how your blog looks by editing the stylesheet or header and footer files. the program sets you up with basic @@ -93,58 +93,68 @@ this.
alias ttbp="~endorphant/bin/ttbp"
to your .bash_aliases for fewer keystrokesalias ttbp-beta="~endorphant/bin/ttbp-beta"
)these are a few ideas being kicked around, or under active development:
(this section is only relevant if you plan on forking the repo and running an instance of this yourself)
+please check out my contributor +guidelines +on github if you'd like to get involved with development!
-if you’re interested in helping with the code, please drop me some tildemail!
+if you find any bugs or strange behavior, please message me locally on tildemail +or open a github issue and i'll get back to you as soon as i can.
-unsolicited pull requests for bug-swatting are greatly appreciated.
+if you're interested in helping with the code, please drop me some tildemail!
\ No newline at end of file diff --git a/README.md b/README.md index cb8bed4..790585f 100644 --- a/README.md +++ b/README.md @@ -15,18 +15,17 @@ 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 +to use, run `feels` 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. +(`feels` is a tilde.town specific command; if you're running this locally, or on +a different server, run `ttbp` from the command line) ### 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` +`feels` ttbp will ask you a few questions to get you started. after that, writing and reading entries all happen within the program. diff --git a/ttbp/ttbp.py b/ttbp/ttbp.py index b7950e8..4e75fc6 100644 --- a/ttbp/ttbp.py +++ b/ttbp/ttbp.py @@ -656,10 +656,10 @@ publicly available on github at https://github.com/modgethanc/ttbp for the full changelog, see ~endorphant/projects/ttbp/changelog.txt -if you have ideas for ttbp, you are welcome to fork the repo and -work on it. i'm only a neophyte dev, so i apologize for any -bad style and practices of mine; i'm always open to suggestions for -improvement. +if you have ideas for ttbp, you are welcome to contact me to discuss them; +please send me tildemail or open a github issue. i am not a very experienced +developer, and ttbp is one of my first public-facing projects, so i appreciate +your patience while i learn how to be a better developer! i'd love to hear about your ideas and brainstorm about new features!