Browse Source

Calling it bb_timestamps.rb now (more general)

master
Yotsubaaa 11 months ago
parent
commit
a2d847cbe1
1 changed files with 10 additions and 10 deletions
  1. +10
    -10
      README.md

+ 10
- 10
README.md View File

@ -1,14 +1,14 @@
# kiwi_timestamps
# bb_timestamps
Make pretty formatted timestamps for Kiwi Farms posts.
Make pretty formatted timestamps using BB codes for Xenforo 2 forum posts.
The Ruby script `kiwi_timestamps.rb` automates the process I use to make timestamps for YouTube streams and videos in my Kiwi Farms posts. See the [Demonstration](#demonstration) below for a usage example.
The Ruby script `bb_timestamps.rb` automates the process I use to make timestamps for YouTube streams and videos in my Kiwi Farms posts. See the [Demonstration](#demonstration) below for a usage example.
Released under the [Unlicense License](https://git.kiwifarms.net/Yotsubaaa/kiwi_timestamps/src/branch/master/LICENSE). Feel free to do anything you want with this script; just don't hold me liable if anything bad happens!
<a name="demonstration"/>
## Demonstration
Here's a step-by-step example of using the `kiwi_timestamps.rb` script to make a pretty list of timestamps.
Here's a step-by-step example of using the `bb_timestamps.rb` script to make a pretty list of timestamps.
#### 1. Write the timestamps using any text editor.
@ -47,19 +47,19 @@ Here's me making some timestamps for a YouTube stream. Note the timestamps file
#### 2. Run `kiwi_timestamps.rb` and grab the output.
#### 2. Run `bb_timestamps.rb` and grab the output.
Once you've written all of your timestamps to a file (called `timestamps_file` for example), simply run the script `kiwi_timestamps.rb` as a Ruby script and pass in your file of timestamps with
Once you've written all of your timestamps to a file (called `timestamps_file` for example), simply run the script `bb_timestamps.rb` as a Ruby script and pass in your file of timestamps with
```bash
ruby kiwi_timestamps.rb timestamps_file
ruby bb_timestamps.rb timestamps_file
```
or, if you've given the script permission to run as an executable,
```bash
./kiwi_timestamps.rb timestamps_file
./bb_timestamps.rb timestamps_file
```
The version of Ruby I had on hand when I wrote the script was Ruby 2.3, so the script should (presumably?) run on any version >=2.3.
@ -67,7 +67,7 @@ The version of Ruby I had on hand when I wrote the script was Ruby 2.3, so the s
When executed, the script prints each of the formatted timestamps to the standard output stream. Optionally redirect the output to a file for easier copy-pasting.
##### Example
Here I run the `kiwi_timestamps.rb` script at the command line, passing in `MADI_timestamps` as an argument and redirecting the script output to a new file `MADI_formatted`. The script only takes a moment to run, and we can see (using `cat MADI_formatted` to look at the file contents) that all of the timestamps have been formatted to include the font and hyperlink information.
Here I run the `bb_timestamps.rb` script at the command line, passing in `MADI_timestamps` as an argument and redirecting the script output to a new file `MADI_formatted`. The script only takes a moment to run, and we can see (using `cat MADI_formatted` to look at the file contents) that all of the timestamps have been formatted to include the font and hyperlink information.
![](kiwi_timestamps_eg2.png)
@ -75,7 +75,7 @@ Here I run the `kiwi_timestamps.rb` script at the command line, passing in `MADI
#### 3. Toggle BB codes for your Kiwi Farms post.
The formatted output text contains the explicit _BB codes_ that are used to format posts on Kiwi Farms (and other XenForo forum boards). But if we paste it into a new post like usual, then those code strings will just appear as text in the post. So we first click the 'Toggle BB code' button in the top-right corner so that the BB codes for the font/url/color/etc are interpreted properly.
The formatted output text contains the explicit _BB codes_ that are used to format posts on Kiwi Farms (and other Xenforo2 forum boards). But if we paste it into a new post like usual, then those code strings will just appear as text in the post. So we first click the 'Toggle BB code' button in the top-right corner so that the BB codes for the font/url/color/etc are interpreted properly.
##### Example
When I go to make my Kiwi Farms post, I click the 'Toggle BB code' button in the top-right corner.

Loading…
Cancel
Save