bitflip is fun

Getting Started · Why? · Plans · Documentation · Contributing

Contributing

devenv is used to provide a reproducible development environment for this project. Follow the getting started instructions.

To automatically load the environment you should install direnv and then load the direnv.

# The security mechanism didn't allow to load the `.envrc`.
# Since we trust it, let's allow it execution.
direnv allow .

At this point you should see the nix commands available in your terminal.

Run the following commands to install all the required dependencies.

install:all

This installs all the node dependencies, cargo binaries and Solana tooling locally so you don't need to worry about polluting your global namespace.

Upgrading devenv

If you have an outdated version of devenv you can update it by running the following commands. If you have an easier way, please create a PR and I'll update these docs.

nix profile list # find the index of the nxi package
nix profile remove <index>
nix profile install --accept-flake-config github:cachix/devenv/<version>

Editor Setup

To set up recommended configuration for your favorite editor run the following commands.

setup:vscode # Setup vscode

License

BSD 3-Clause, see the LICENSE file.

Thoughts

Open source products are public goods.

Public goods should be publicly auditable.

The blockchain is designed for providing a solution to these constraints.

Funds can be raised and then audited directly by the community.

Funds which are misappropriated can lead to a fork of the project which will diminish the desirability of the original project.

This does leave the possibility open for reputation attacks.

!C Can we chat?