ike/rot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

clarify dev instructions

Browse Source
This commit is contained in:
Isaac Lewis 2026-01-15 10:42:26 -08:00
parent 05f3c7ea3d
commit 655763aa42
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -18,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.
@ -40,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 .
```