nix-weather/README.md

Fortune Kind

Note

This software is under active development. It's a great time to contribute!

Try it with Nix ❄️

If you already have Nix setup with flake support, you can try out fortune-kind with the nix run command:

nix run github:cafkafk/fortune-kind

Nix will build fortune-kind and run it.

If you want to pass arguments this way, use e.g. nix run github:cafkafk/fortune-kind -- -s.

Installation

Nix/NixOS ❄️

Imparative Installation

For nix profile users:

nix profile install github:cafkafk/fortune-kind#

Warning

Installing packages imperatively isn't idiomatic Nix, as this can lead to many issues.

Declarative Installation

To add it to your flake.nix:

{
...
    inputs.fortune-kind.url = "github:cafkafk/fortune-kind";
...
}

Then, add it to your systemPackages wherever you prefer:

{ inputs }: {
  environment.systemPackages = [
    inputs.fortune-kind.packages.${pkgs.system}.default
  ];
}

Installing From crates.io

Important Installing from crates.io won't set a FORTUNE_DIR

To install the crate:

cargo install fortune-kind

Motivation

Many distributions have faced challenges with fortune-mod due to concerns about its maintainer and the presence of contentious fortunes in its data files. Instead of trying to replace fortune-mod or recreate a historically accurate fortune program, our goal is to serve those who value handpicked fortunes.

Contributing

We welcome contributions! If you find any issues or have suggestions, please open an issue. If you'd like to contribute directly, feel free to open a pull request.

Fortune Acceptance Process

We manually integrate fortunes from fortune-mod, moving them from the oldtunes directory to the fortunes directory. Each fortune undergoes a rigorous manual verification process. While the selection criteria can be a topic of discussion, the final say rests with cafkafk's judgment.

For more info about contributing and the acceptance policy, please see EDITORIAL.md