Skip to content

Commit d2883db

Browse files
committed
Updated readme
1 parent 70681e0 commit d2883db

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,39 @@ Released Under [**World Bank Dataset Terms of Use**](http://web.worldbank.org/WB
4747
2. Navigate into this folder "world-dev-indicators" through command line.
4848
3. Type:
4949

50-
51-
$make clear_all
50+
```
51+
make clear_all
52+
```
5253
5354
5455
This will clear all the result files which come with this repo.
5556

5657
4. Now, type:
5758

58-
59-
$make all
59+
```
60+
make all
61+
```
6062
6163
This will run all the scripts in the `src/` folder as per the sequence in `Makefile` and render the analysis in the `results/` folder.
6264

6365
### Docker
6466

65-
1.
67+
1. Download from Docker
68+
69+
```
70+
docker pull simransethi/world-dev-indicators
71+
```
72+
73+
2. Clean, so that you can build from start:
74+
75+
```
76+
docker run --rm -v **insert-location-to-repo-in-local-systme**:/home/world-dev-indicators simransethi/world-dev-indicators make -C '/home/world-dev-indicators' clear_all
77+
```
78+
3. Run the whole analysis:
79+
80+
```
81+
docker run --rm -v **insert-location-to-repo-in-local-systme**:/home/world-dev-indicators simransethi/world-dev-indicators make -C '/home/world-dev-indicators' all
82+
```
6683

6784
**The final report is rendered at this location: `doc/final_report/`**
6885

0 commit comments

Comments
 (0)