README.md Clarification

openzim / ted

Provide the best of TED.com for offline usage!

https://download.kiwix.org/zim/ted/

GNU General Public License v3.0

13 stars 8 forks source link

README.md Clarification #173

Closed JeremiahHerring closed 3 months ago

JeremiahHerring commented 3 months ago

Hello, I was trying to contribute to this repository but needed help installing all the dependencies. I believe something may be missing in the readme of this repository, as I followed all the instructions carefully and installed everything that was listed. When I type "pip3 install ted2zim" in the terminal, I get the following error:

I believe I need to install the libzim library, however I am not sure how to find it. If this is the case, the README should also be updated.

benoit74 commented 3 months ago

@JeremiahHerring could you please share how you solved this? If you stumbled on this issue, others might have the same problem. From my experience, it is often a problem of wrong Python version being used, do you confirm?

JeremiahHerring commented 3 months ago

@benoit74 I realized that the problem was I was using the Windows terminal, and it started functioning when I used Ubuntu instead. I can open a pull request for the readme to specify that it doesn't function for the Windows terminal if that is correct. I think it would help other new contributors as well.

benoit74 commented 3 months ago

This comment is probably enough for now, I'm not sure your issue is totally linked to Windows, you've probably changed many other things when switching to Ubuntu (including Python version which is still my favorite assumption) and Windows is supposed to work as well (or we might have only a temporary issue to fix, so better not update the README with "false" statments)