mirror of
https://github.com/tildeclub/ttbp.git
synced 2026-06-29 23:19:24 +00:00
tilde.club fork
This commit is contained in:
42
README.md
42
README.md
@@ -1,33 +1,33 @@
|
||||
*a command-line based blogging platform running on tilde.town*
|
||||
*a command-line based blogging platform*
|
||||
|
||||
`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.club. 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, to tilde.town's gopher server, or
|
||||
keep all your entries private to the tilde.town server.
|
||||
public html file hosted on your tilde page, to tilde.club's gopher server, or
|
||||
keep all your entries private to the tilde.club server.
|
||||
|
||||
to use, run `feels` while logged in to tilde.town
|
||||
to use, run `feels` while logged in to tilde.club
|
||||
|
||||
this is a project that runs on tilde.town, so all users of this program are
|
||||
expected to operate under the tilde.town [code of
|
||||
conduct](http://tilde.town/wiki/conduct.html). content/personal issues should be
|
||||
this is a project that runs on tilde.club, so all users of this program are
|
||||
expected to operate under the tilde.club [code of
|
||||
conduct](https://tilde.club/wiki/code-of-conduct.html). content/personal issues should be
|
||||
worked out according to the CoC, with support from the [administrative
|
||||
team](http://tilde.town/wiki/administration/index.html) if needed.
|
||||
team](https://tilde.club/wiki/code-of-conduct.html#contact-info) if needed.
|
||||
|
||||
|
||||
### QUICK START
|
||||
|
||||
no coding or html experience is necessary to get started. just log in to your
|
||||
tilde.town account and enter:
|
||||
tilde.club account and enter:
|
||||
|
||||
`feels`
|
||||
|
||||
@@ -39,11 +39,11 @@ 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
|
||||
behavior, please send internal tilde.club mail to ~endorphant and i'll try to
|
||||
sort things out!
|
||||
|
||||
there's also a function from the main menu that lets you send feedback/inquiries
|
||||
to me directly; this uses internal tilde.town mail, which is what i'll respond
|
||||
to me directly; this uses internal tilde.club mail, which is what i'll respond
|
||||
to.
|
||||
|
||||
### writing entries
|
||||
@@ -51,7 +51,7 @@ to.
|
||||
entries are recorded as plaintext files in your `~/.ttbp/entries` directory.
|
||||
`ttbp` will use your selected editor to open and write files; each day is its
|
||||
own entry, like a diary page. at midnight for whatever timezone you've set for
|
||||
your user account on tilde.town, you'll get a fresh entry. if you don't write
|
||||
your user account on tilde.club, you'll get a fresh entry. if you don't write
|
||||
any feels on a particular day, no entries will show up there.
|
||||
|
||||
when you save and quit the text editor, your entry will automatically propagate
|
||||
@@ -79,7 +79,7 @@ by creating files with any date you want.)*
|
||||
### reading other feels
|
||||
|
||||
the `browse global feels` feature shows the ten most recent entries that anyone
|
||||
has written on ttbp. this list is only accessible from within tilde.town,
|
||||
has written on ttbp. this list is only accessible from within tilde.club,
|
||||
although individual entries may be posted to html or gopher.
|
||||
|
||||
you can also pull up a list of a single user's feels through `check out your
|
||||
@@ -91,7 +91,7 @@ opted to publish their posts.
|
||||
private information, even if a particular user is publishing entries in a
|
||||
world-viewable way! please be respectful about having access to other people's
|
||||
feels, and do not copy/repeat any information without getting their explicit
|
||||
permission. tilde.town operates on a high level of mutual trust, and `ttbp` is
|
||||
permission. tilde.club operates on a high level of mutual trust, and `ttbp` is
|
||||
designed to give individuals control over their content.
|
||||
|
||||
### subscribing to users
|
||||
@@ -113,7 +113,7 @@ when you start your ttbp, you have the option of publishing or not publishing
|
||||
your blog.
|
||||
|
||||
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
|
||||
the tilde.club network; other tilde.club users will still be able to read your
|
||||
entries through the ttbp interface, or by directly accessing your
|
||||
`~/.ttbp/entries` directory.
|
||||
|
||||
@@ -123,7 +123,7 @@ directory.
|
||||
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](https://tilde.town/~endorphant/ttbp).
|
||||
page](https://tilde.club/wiki/ttbp.html).
|
||||
|
||||
you can also opt to publish to gopher, and the program will automatically
|
||||
generate a gophermap of your feels.
|
||||
@@ -143,7 +143,7 @@ them from within the program can help keep your files properly linked up.
|
||||
posts. entries marked `(nopub)` will not get written to html or gopher,
|
||||
and toggling them from this menu will immediately publish or unpublish
|
||||
that entry (if you're not publishing your posts at all, these settings
|
||||
won't matter, since your feels will never show up outside of tilde.town)
|
||||
won't matter, since your feels will never show up outside of tilde.club)
|
||||
* **backup your feels**--makes a .tar.gz of all your entries, saving one
|
||||
copy to `~/.ttbp/backups/` with the current date, and a second copy to
|
||||
your home directory for safekeeping.
|
||||
|
||||
Reference in New Issue
Block a user