Skip to main content

Contribute

Pre-requisites​

  1. Go v1.19 or above
  2. Just
  3. Node.js 16 or above (optional, only needed for building documentation site)

Using nix​

waymond repo contains nix package manager configuration to enable contributiors to easily get all the needed software for development.

# clone waymond repo

$ cd waymond

$ nix-shell

# happy hacking!

Build and run​

$ just build

# waymond binary should be ready for use.

$ ./waymond

Develop Docs​

$ just run-site

# runs the website locally

$ just deploy

# deploys this site to GitHub pages