Compare commits

..

2 Commits
0.1 ... main

Author SHA1 Message Date
Isaac Lewis
655763aa42 clarify dev instructions 2026-01-15 10:42:26 -08:00
Isaac Lewis
05f3c7ea3d add release links to readme 2026-01-15 10:40:19 -08:00

View File

@ -8,6 +8,8 @@ This program is used in a poetry project that lives here: [tilde.town/~ike/rot.h
## Usage
Download binary: [macOS](https://git.tilde.town/ike/rot/releases/download/0.1/rot-darwin), [linux_amd64](https://git.tilde.town/ike/rot/releases/download/0.1/rot-linux_amd64)
Before using this program, you need to have a poem file ready. This is a plain text file.
To use this program in production, run the binary with the the first parameter as the poem file, and the second parameter as the html file to update. For example:
@ -16,12 +18,6 @@ To use this program in production, run the binary with the the first parameter a
$ rot ~/poem.txt /var/www/rot.html
```
To use this program in development, you can run it with `go run`:
```
$ go run main.go poem.txt test.html
```
Every time this program runs, it will take the contents of the poem file, "rot"
it using its algorithm, write the contents to the html file, and then update the
poem file with the new rotted contents.
@ -38,7 +34,18 @@ on a regular interval, for example, every hour:
To build the program, make sure you have [Go](https://golang.org/dl/) installed.
These instructions assume you have Go 1.24 or later, and are running on macOS.
Then, clone this repository and run:
Clone the repository:
```
$ git clone https://git.tilde.town/ike/rot.git
$ cd rot
```
To use this program in development, you can run it with `go run`:
```
$ go run main.go poem.txt test.html
```
To build a binary for macOS, run:
```
$ go build -o dist/rot-darwin .
```