A small TL;DR to describe what the main aim of the repo is.
A longer description about what the repo contains and a link to the docs.
A list of all dependencies, tech stack and external libraries used
- Solidity v0.8.15
- NodeJS v14
- Foundry
- Circom ...
Specify what works and what doesn't
- feature 1
- feature 2
- feature n
We need to source the required dependencies first
$ sudo apt-get update
$ sudo apt-get install python3 ...
Moving on to set up the project
$ git clone https://github.com/KeyringNetwork/AngryAlex
$ yarn install
$ yarn build
Running the tests
$ yarn test
$ ./run .
Can be listed inline as a blurb of code or as a link to a separate folder.
This code is released under a MIT/BUSL/GPLv3 license.