Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Skip to content
README.md 1011 B
Newer Older
# General information
The current documentation uses [Jekyll](https://jekyllrb.com/docs) as the static site generator. [Docker](https://www.docker.com/) is required to run the project.

Romain Hunault's avatar
Romain Hunault committed
# How to run

For faster development process, the following command is recommended:

Romain Hunault's avatar
Romain Hunault committed
```shell
$ docker run --rm --volume="$PWD:/srv/jekyll" -p 4000:4000 -p 35729:35729 -it jekyll/jekyll:4.2.0 jekyll serve --profile --incremental --livereload
Romain Hunault's avatar
Romain Hunault committed
```

Note: the port 35729 is used for live reload

Or you could use:

```shell
$ docker run --rm --volume="$PWD:/srv/jekyll" -p 4000:4000 -it jekyll/jekyll:4.2.0 jekyll serve
```

Generate for a device

```shell
$ ./scripts/generate_device.sh starlte "Galaxy S9" Samsung oreo "dev, stable"
Romain Hunault's avatar
Romain Hunault committed
```

pay attention to file user, a `chmod -R 1000:1000 wiki` could help 

To build user this command as an example:

Arnau Vàzquez's avatar
Arnau Vàzquez committed
manoj@RIANControl:~/user$ docker run -it --rm --volume="/home/manoj/user:/srv/jekyll" -p 4000:4000  -it jekyll/jekyll:4.2.0 jekyll serve

Replace here /home/yourhomefoldername/