1
0
forge-proposal-template/README.md

47 lines
807 B
Markdown
Raw Permalink Normal View History

2023-06-06 13:15:27 +03:00
# Proposal title
### Changes / effect description
- 1
- 2
- ...
2023-06-06 13:15:27 +03:00
### 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))
2023-06-06 13:15:27 +03:00
### Installation
```text
git clone --recurse-submodules <proposal-repo-link>
cd <proposal-name>
npm install
npm run init
2023-06-06 13:15:27 +03:00
```
### Testing
```text
npm run test:windows
```
or
```text
npm run test:linux
```
##### Test with gas
```text
npm run test:gas:windows
```
or
```text
npm run test:gas:linux
```