Skip to content

Commit

Permalink
Merge pull request #423 from openzim/improved-readme
Browse files Browse the repository at this point in the history
Improved readme
  • Loading branch information
kelson42 authored Aug 24, 2024
2 parents 296f0f9 + 429339e commit fab5063
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ Most famous tools are:

* `zimdump` inspects or dumps (part of) a [ZIM](https://openzim.org) file.

* `zimsplit` splits
[smartly](https://wiki.openzim.org/wiki/ZIM_file_format#Split_ZIM_archives_in_chunks)
a ZIM file in smaller chunks.

* `zimwriterfs` creates [ZIM](https://openzim.org) files from a
locally-stored directory containing "self-sufficient" HTML content
(with pictures, javascript and stylesheets). The result will contain
Expand Down Expand Up @@ -125,7 +129,7 @@ where you want to install the libraries. After the installation
succeeded, you may need to run ldconfig (as root).

Uninstallation
------------
--------------

If you want to uninstall the ZIM tools:
```bash
Expand All @@ -135,10 +139,10 @@ ninja -C build uninstall
Like for the installation, you might need to run the command as user
`root` (or using `sudo`).

Docker
------
Container
---------

A Docker image with `zimwriterfs`, `zimcheck`,`zimdump` and all the
A container image with `zimwriterfs`, `zimcheck`, `zimdump` and all the
other tools can be built from the `docker` directory. The project
maintains an official image available at https://ghcr.io/openzim/zim-tools.

Expand Down

0 comments on commit fab5063

Please sign in to comment.