Skip to content

Commit ea13c7a

Browse files
committed
Update README.md
1 parent ee6c8e2 commit ea13c7a

2 files changed

Lines changed: 14 additions & 12 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export NVM_VERSION=v0.40.4
55

66
export ISIMIP_LOG_LEVEL=WARNING
77

8-
.PHONY: all csvtablescsvtables definitions glossary pattern protocol schema tree \
8+
.PHONY: all csvtables definitions glossary pattern protocol schema tree \
99
serve typos app watch lint clean cleannode cleanenv distclean
1010

1111
all: csvtables definitions glossary pattern protocol schema tree

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,31 @@ You can also edit the markdown files at github directly. With a delay of minutes
99

1010
As a rule, the sector-specific text should be kept to a minimum and cover as much structure as possible by machine-readable code under [definitions](definitions/).
1111

12+
1213
Setup
1314
-----
1415

1516
Building the protocol requires:
1617

17-
- **git**: for version control
1818
- **Python** (> 3.10)
19-
- **curl**: for downloading nvm in the app Makefile
19+
- **git** for version control
20+
- **curl** for downloading `nvm`
2021

2122
The installation of Python (and its developing packages) differs from operating system to operating system. Instructions to setup Python for your system can be found [here](https://utils.isimip.org/prerequisites/).
2223

23-
If you work with different Python applications, we recommend to create a virtual environment for the protocol:
24+
We recommend to create a virtual environment for the protocol:
2425

2526
```bash
2627
python3 -m venv env
2728
source env/bin/activate # the env needs to be sourced everytime you use a new terminal
2829
```
2930

30-
The Python requirements are installed using:
31+
The Python requirements can be installed using:
3132

3233
```bash
3334
pip install -r requirements.txt
3435
```
3536

36-
The JavaScript part of the protocol needs to be build using NodeJS and Webpack. For convenience this can be done by using only ([nvm]() and the Node dependencies are downloaded automatically, this requires `curl`):
37-
38-
```bash
39-
make app
40-
make watch # automatically rebuild when the source changes
41-
```
4237

4338
Build
4439
-----
@@ -49,7 +44,14 @@ The different `build` scripts can be run by using:
4944
make
5045
```
5146

52-
The output files are located in `output`. The files, e.g. `index.html` can opened with a web browser.
47+
The output files are located in `output`.
48+
49+
The JavaScript part of the protocol needs to be build using NodeJS and Webpack. For convenience this can be done by using ([nvm](https://github.com/nvm-sh/nvm) and the Node dependencies are downloaded automatically, this requires `curl`):
50+
51+
```bash
52+
make app
53+
make watch # automatically rebuild when the source changes
54+
```
5355

5456

5557
Development server

0 commit comments

Comments
 (0)