From 655763aa427b4ca6236b272830f372e87fa0d3bc Mon Sep 17 00:00:00 2001 From: Isaac Lewis Date: Thu, 15 Jan 2026 10:42:26 -0800 Subject: [PATCH] clarify dev instructions --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f9b7ea5..80a6707 100644 --- a/README.md +++ b/README.md @@ -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 . ```