search

openzim / kolibri

Convert a Kolibri channel in ZIM file(s)
GNU General Public License v3.0
8 stars 12 forks source link

Detailed documentation is unavailable for usage of kolibri2zim #108

Closed Sudarshan-21 closed 6 months ago

Sudarshan-21 commented 6 months ago

Current state of repository does not contain any user instruction documents for beginners, on how to make use of kolibri2zim tool. It would be really helpful for the new users if there is a user instruction manual.

Sudarshan-21 commented 6 months ago

@benoit74 @githyuvi @ayushanand308 I would like to take up this task, would you please guide me through or can you please refer me any material for this work.

benoit74 commented 6 months ago

If material was already available, you wouldn't have to open issue 🤣

And if I had time to guide you, I would probably prefer to use it to write all this documentation rather than explaining it to you, loosing information, spending time to review your work, ...

The only material available I can think of is the usage you can get by running kolibri2zim --help. And this is already explained in README.md. I'm quite sure we will refuse to duplicate all this usage documentation to a second place, at least if updates are not automated. It is already a burden to maintain this up-to-date in a single place, we do not want to have two places which will get out of sync for sure.

The only suggestion I have for now it that you experiment with the tool like all users/developers do, understand how it works, and convert your knowledge into documentation.

Sudarshan-21 commented 6 months ago

ohh, you're right. I'll try to do this.