From d7b72d1c5f115f21ceecdee5f0b80842c16aec4e Mon Sep 17 00:00:00 2001 From: Theo Date: Tue, 6 Jun 2023 03:15:27 -0700 Subject: [PATCH] Add template README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..76d531f --- /dev/null +++ b/README.md @@ -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 +cd +npm install +``` + +### Testing + +```text +npm run test +``` \ No newline at end of file