Installing

Neuron can be installed on Linux and macOS using the Nix package manager.

Prerequisites

First, install the Nix package manager:

bash <(curl https://nixos.org/nix/install)

Optionally, enable the Nix cache if you would like to speed up local builds:

# If you do not already have cachix, install it:
nix-env -iA cachix -f https://cachix.org/api/v1/install
# Enable nix cache for rib
cachix use srid

Install neuron

Run the following command to build and install the neuron executable:

nix-env -if https://github.com/srid/neuron/tarball/master

For alternative mechanisms, see 2012401Declarative Install.

Test your install

Make sure that you can execute the neuron executable. You should expect the following:

$ neuron --help
Usage: neuron NOTESDIR COMMAND
  Zettelkasten based on Rib

Available options:
  -h,--help                Show this help text

Available commands:
  new                      Create a new zettel
  rib                      Call rib

What’s next?

Proceed to the 2011502Tutorial.

Navigate up