octad

simple octad puzzle generator (and soon solver)

installation

octad is available as a crate on crates.io

install cargo through either your package manager or rustup, then run:

cargo install octad

no other packages will be officially distributed and maintained.

in case you are packaging octad for a different package manager, please create an issue that links to the package page or packaging request and i'll add it into this README.

in case you still can't run octad globally, add the following line to your .profile in case you're using bash, or .zprofile in case you're using zsh:

. "$HOME/.cargo/bin"

if you're using NixOS, you can add the following line to your configuration:

environment.localBinInPath = true;

then create a symlink that points to the octad executable in ~/.local/bin:

cd ~/.local/bin
ln -s ~/.cargo/bin/octad octad

or you can also add octad as an alias in programs.zsh.shellAliases (better for reproducibility):

octad = "~/.cargo/bin/octad";

building

1. clone the repository:

git clone https://codeberg.org/switchcartridges/octad

2. go into the repository and build it with cargo:

cargo build --release

omit the --release option if you want the debug build, however be aware that debug builds are slower after cargo is done building, the compiled binary is going to be in target/release/octad

3. (optional, only do if youre installing the program this way) add an alias for octad adding an alias is simple; add the following line to your .bashrc or .zshrc:

alias octad="<repository directory>/target/release/octad"

if you're using NixOS like i am, add the following line to programs.zsh.shellAliases in either configuration.nix or home.nix:

octad = "<repository directory>/target/release/octad";