1
0

Add template README

This commit is contained in:
Theo 2023-06-06 03:15:27 -07:00
parent 4df2a50408
commit d7b72d1c5f

27
README.md Normal file

@ -0,0 +1,27 @@
# Proposal title
### Changes / effect description
- 1
- 2
- ...
### Requirements
- Rust ([Need only for Windows](https://doc.rust-lang.org/cargo/getting-started/installation.html))
- Foundryup ([Windows](https://github.com/altugbakan/foundryup-windows), [Linux](https://book.getfoundry.sh/getting-started/installation))
- Node 14 or higher ([Windows](https://github.com/coreybutler/nvm-windows), [Linux](https://github.com/nvm-sh/nvm))
### Installation
```text
git clone --recurse-submodules <proposal-repo-link>
cd <proposal-name>
npm install
```
### Testing
```text
npm run test
```