openzim / python-libzim

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

Clean-up repo #116

Closed rgaudin closed 3 years ago

rgaudin commented 3 years ago

There are a few things that should maybe be removed or moved:

I'd rather have an extended and more user-friendly README than all those files in the root of the repo.

mgautierfr commented 3 years ago

The lib and include folders are here to allow the user/developer to put the headers and library locally and have python-libzim use them. Do we want to remove them ?

Do we move to something like ? :

rgaudin commented 3 years ago

I'd advise in keeping it as it is but instead of having those two folders in the root, have a placeholder like libzim_dist or something similar in which to extract the downloaded version ; which itself has the two folders. Clearer, easier to replace with different version.