openzim / openzim/overview

specification on how to create ZIM files

Open
#83 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
HTML
Stars
9
Forks
2
PR merge metrics
No merged PRs in 30d

Description

I have taken a look at the Zim file format but it seems to me it is only useful to people who want to implement readers (not sure if I am correct). Is there a documentation specifying how to create ZIM files such that implementations can exist in other languages and all conform to the spec?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked ZIM file format specification and the repository overview. Determine whether it explains how to create files, then define what creator-focused documentation is missing for implementations in other languages; done means the required creation guidance is documented clearly enough to support conforming implementations.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.