From 82af3b5d471013b092dc0a066476f581298de390 Mon Sep 17 00:00:00 2001
From: Valerie <sleeplessval@gmail.com>
Date: Wed, 6 Mar 2024 18:51:46 -0500
Subject: [PATCH] added justfile and updated README

---
 .gitignore |  2 ++
 README.md  | 49 ++++++++++++++++++++++++++++++++++++++++++++++++-
 justfile   |  7 +++++++
 3 files changed, 57 insertions(+), 1 deletion(-)
 create mode 100644 .gitignore
 create mode 100644 justfile

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..66cc710
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+/target/
+
diff --git a/README.md b/README.md
index b258a81..c27de11 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,53 @@ A no-nonsense, user-extensible `fortune-mod` replacement.
 ## Goals
 
 - Sensible: I'm fed up with fortunes about men hating their wives.
-- Straightforward: No weird formats. Plain text with `\n` escape sequences.
+- Straightforward: No weird formats. Plain text with `\n` escape sequences; easy to add or remove content.
 
+This project was originally built in Rust, and I migrated it to C# primarily to
+test out [bflat](https://github.com/bflattened/bflat).
+
+## Installation
+
+### Application
+
+<details>
+<summary>Release Binary</summary>
+
+Copy the compiled binary from the [releases page](https://git.vwolfe.io/valerie/fortune-cs/releases)
+to a directory in `$PATH`, such as `/usr/bin/`.
+
+</details>
+
+<details>
+<summary>From Source</summary>
+
+Clone the source repository and either use the prewritten [just](https://github.com/casey/just)
+recipe with the command `just build`, or run `bflat build ./src/Program.cs` if
+you'd rather set your build options manually.
+
+</details>
+
+### Base Fortunes
+
+<details>
+<summary>Release Tarball</summary>
+
+Copy the `base-fortunes.tar.gz` tarball from the [releases page](https://git.vwolfe.io/valerie/fortune-cs/releases),
+extract the archive using `tar xzf base-fortunes.tar.gz`, and move the
+resulting `.txt` files to `/usr/share/fortune-cs/`.
+
+</details>
+
+<details>
+<summary>From Source</summary>
+
+Clone the source repository and copy the files from the `data/` directory to
+`/usr/share/fortune-cs`.
+
+</details>
+
+## Dependencies
+
+- [bflat](https://github.com/bflattened/bflat): Compiler
+- [just](https://github.com/casey/just): Build recipe
 
diff --git a/justfile b/justfile
new file mode 100644
index 0000000..d18a016
--- /dev/null
+++ b/justfile
@@ -0,0 +1,7 @@
+
+build:
+	bflat build -o ./target/fortune-cs --no-reflection --no-stacktrace-data --no-globalization --no-debug-info --no-pie
+
+fortunes:
+	cd data & tar czf ../target/base-fortunes.tar.gz ./*.txt
+