Skip to content

Commit d789131

Browse files
committed
README: Write "prerequisites" section
1 parent 73b389d commit d789131

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ You can see it live at [https://stake.eosnetwork.com](https://stake.eosnetwork.c
1818
<!-- contents markdown begin -->
1919

2020
1. [Development](#development)
21+
1. [Prerequisites](#prerequisites)
2122
1. [See Also](#see-also)
2223

2324
<!-- contents markdown end -->
@@ -33,6 +34,22 @@ Start here to build this project or to contribute to this repo.
3334
> [!NOTE]
3435
> The source of truth for the version of nodeJS this project supports is the [`.nvmrc`](./.nvmrc) file. Backward- or forward-compatibility with other versions of `node` is made on a best-effort basis, but is not guaranteed.
3536
37+
### Prerequisites
38+
You will need the following tools:
39+
- [nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
40+
- [nodeJS](https://www.w3schools.com/nodejs/nodejs_intro.asp)
41+
Install `node` using `nvm`. In the root of this repo:
42+
```bash
43+
nvm install
44+
```
45+
This will automagically install and use the correct version of `node` for this project, as defined in the [`.nvmrc`](./.nvmrc) file.
46+
- [yarn](https://yarnpkg.com) version 1
47+
The easiest way to install this is using `npm`, which is installed with `node` by `nvm`.
48+
```bash
49+
npm install --global yarn
50+
```
51+
These tools are all you need to get started!
52+
3653
## See Also
3754
More resources.
3855
- [aws-cloudwatch-alarm-handler](https://github.com/eosnetworkfoundation/aws-cloudwatch-alarm-handler) lambda

0 commit comments

Comments
 (0)