Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactored shell scripts. Fix - #91 #92

Merged
merged 3 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
- Enhance contribution guidelines: Refactored shell scripts, added additional steps.
benoit74 marked this conversation as resolved.
Show resolved Hide resolved

## [1.2.0] - 2024-02-16

Expand Down
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

* Open issues, bug reports and send PRs [on github](https://github.com/openzim/kolibri2zim).
* Make sure it's `py3.6+` compatible.
* Docker (which engine must run in the background).
* Use [black](https://github.com/psf/black) code formatting.
* `pre-commit` must be activated before (code must pass all pre-commit checks to succeed in the CI)

## notes

Expand Down Expand Up @@ -44,7 +46,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"
```

Expand Down