Update README add installation instructions

[Redsandro]

#41 (comment)

[mara004]

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

[Redsandro]

(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]

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]

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]

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]

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]

Thanks, mind if I squash the commits into one?

[Redsandro]

Not at all, do what you want. 🙂

[mara004]

Any reason you are always leaving 2 lines empty? I think 1 should be quite sufficient...

[MerlijnWajer]

I can fix that up

[Redsandro]

Any reason

When in Rome, do as the Romans do. 🙂 I looked at the first existing code block I found (under "Usage")

[mara004]

I'm not sure if it makes sense to duplicate the whole section. I personally wouldn't do that.

[MerlijnWajer]

I think it's not too bad, if anything, maybe the README ought to refer to the docs for specifics.

[MerlijnWajer]

I've merged this to master, thanks