Skip to content

Commit b32d8d0

Browse files
authored
Merge pull request #8 from OpenIndexMaps/mejackreed-patch-1
Update README.md
2 parents c9bc03a + 3a778bd commit b32d8d0

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,38 @@
22

33
This is the website for OpenIndexMaps.org
44

5-
## Build process
5+
## Installation
6+
Requires both Ruby (to run Jekyll) and JavaScript / NPM to compile JavaScript
7+
8+
### Building JavaScript
9+
Install JavaScript dependencies
10+
```sh
11+
$ npm install
12+
```
13+
14+
Building JavaScript
15+
```sh
16+
$ npx webpack
17+
```
18+
19+
Continously watch and build
20+
```sh
21+
$ npx webpack --watch
22+
```
23+
24+
### Building Jekyll site
25+
Install Jekyll and Ruby dependencies
26+
```sh
27+
$ bundle install
28+
```
29+
30+
Running Jekyll
31+
```sh
32+
$ bundle exec jekyll serve
33+
```
34+
35+
36+
## Build process on Netlify
637
```sh
738
npm i; npx webpack; jekyll build
839
```

0 commit comments

Comments
 (0)