search

tldr-pages / tldr-python-client

:snake: Python command-line client for tldr pages 📚
https://pypi.org/project/tldr/
MIT License
599 stars 95 forks source link

Cache file could be better documented in the readme file #84

Closed anakimluke closed 4 years ago

anakimluke commented 4 years ago

It might be a good idea to briefly mention in the readme file something about what's going on with the cache file; that it's an automated process: data is pulled from the tldr repo, zipped, commited to the tldr webpage repo, downloaded to the client and then unzipped.

I think it should be more clear to the user what's the source of the data the client downloads. I had to look at the source of this python client, at the tldr website repo, at this code and then at this other script to figure where's the file coming from.

anakimluke commented 4 years ago

Oh, it's a bit more complicated than I thought. Individual pages can be downloaded and cached too.