search

openzim / python-libzim

Libzim binding for Python: read/write ZIM files in Python
https://pypi.org/project/libzim/
GNU General Public License v3.0
67 stars 25 forks source link

Supply mandatory metadata in writer example #193

Closed stuartlangridge closed 5 months ago

stuartlangridge commented 5 months ago

A zim file has certain mandatory requirements in the metadata; for example, Language, Date, and Illustration must be present. If they aren't, then some ZIM reader apps (such as Kiwix for iOS) will refuse to open the zim file. So, add these mandatory pieces to the example code in the readme, so that if you generate a zim file by following the example code, it will be valid. (Discovered in https://github.com/kiwix/kiwix-apple/issues/842)

stuartlangridge commented 5 months ago

Sure thing; those changes seem fine to me!