fortune-cs/README.md

1.5 KiB

Fortune

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; easy to add or remove content.

This project was originally built in Rust, and I migrated it to C# primarily to test out bflat.

Installation

Application

Release Binary

Copy the compiled binary from the releases page to a directory in $PATH, such as /usr/bin/.

From Source

Clone the source repository and either use the prewritten just recipe with the command just build, or run bflat build ./src/Program.cs if you'd rather set your build options manually.

Base Fortunes

Release Tarball

Copy the base-fortunes.tar.gz tarball from the releases page, extract the archive using tar xzf base-fortunes.tar.gz, and move the resulting .txt files to /usr/share/fortune-cs/.

From Source

Clone the source repository and copy the files from the data/ directory to /usr/share/fortune-cs.

Dependencies