Refactored shell scripts

openzim · Feb 23, 2024 · bdd0bdb · bdd0bdb
1 parent ef8e6e3
commit bdd0bdb
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix caching of re-encoded video files (#82)
 - Do not start multiple video processing threads by default (`--processes` default value) (second part of #83)
 - Fix logging issue in DEBUG mode
+- Refactored some shell scripts in `CONTRIBUTING.md` (#91)
 
 ## [1.1.1] - 2024-01-16
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -36,6 +36,7 @@ To simplify this, it is possible to:
 - iterate on ZIM UI code
 
 To achieve this, first build the Docker image based on current code base.
+Make sure Docker is running in the background ("Docker Deamon" app for Windows and Mac, or `docker start` in Linux).
 
 ```
 docker build -t local-kolibri2zim .
@@ -44,7 +45,7 @@ docker build -t local-kolibri2zim .
 Scrape a channel (here we use the minimal channel, but you could use any other one of interest for your UI developments).
 
 ```
-docker run --rm -it -v $PWD/output:/output local-kolibri2zim kolibri2zim --name "minimal_test" --title "Minimal Kolibri Channel Test" --description "This is a minimal K
+docker run --rm -it -v "$PWD/output:/output" local-kolibri2zim kolibri2zim --name "minimal_test" --title "Minimal Kolibri Channel Test" --description "This is a minimal K
 olibri Channel, with new Kolibri UI" --channel-id "7f744ce8d28b471eaf663abd60c92267" --zim-file "Minimal_Test.zim"
 ```