internetarchive / archive-pdf-tools

Fast PDF generation and compression. Deals with millions of pages daily.
https://archive-pdf-tools.readthedocs.io/en/latest/
GNU Affero General Public License v3.0
86 stars 13 forks source link

Update README add installation instructions #44

Closed Redsandro closed 2 years ago

Redsandro commented 2 years ago

https://github.com/internetarchive/archive-pdf-tools/issues/41#issuecomment-1119541727

mara004 commented 2 years ago

I think that's a helpful addition. One can't expect that anyone is familiar with Python tooling.

Redsandro commented 2 years ago

(You may notice a couple more commits. The problem is that I can't get the code blocks to render correctly even though I believe I use the correct markdown. Perhaps someone with merge permission can fix it if it still doesn't render correctly after merge.)

MerlijnWajer commented 2 years ago

I think this is helpful, but I think it might also make sense to mention that the tagged releases are available on https://pypi.org/project/archive-pdf-tools/ - which means people can run pip install archive-pdf-tools==1.4.14 for example.

BTW: I have been working on making the read the docs version better, which is here: https://archive-pdf-tools.readthedocs.io/en/latest/ - it's basically a more comprehensive version of the readme (some of it is copy paste)

I think having an installation chapter there would also be good.

Redsandro commented 2 years ago

it might also make sense to mention that the tagged releases are available on

Sounds good. Would you like me to amend the PR or are you asking for opinions before you amend the PR?

I have been working on making the read the docs version better, which is here:

Where can this be amended? Is it automatically generated from the docs/ folder?

MerlijnWajer commented 2 years ago

Right, that's correct, that is in docs/. And yes, you can add it to the PR here if you're up for it.

Redsandro commented 2 years ago

you can add it to the PR here if you're up for it.

Ok, that's about it. Sorry for the many commits. I didn't know RST, thought it was similar to MD. But now it works.

MerlijnWajer commented 2 years ago

Thanks, mind if I squash the commits into one?

Redsandro commented 2 years ago

Not at all, do what you want. :slightly_smiling_face:

MerlijnWajer commented 2 years ago

I've merged this to master, thanks