Installation instructions: please update the readme front page

[m040601]

Thanks for your work providing this tool. I ended up here looking for an alternative to python stapler.

There's a lot of good and important stuff on the README.

Please add one or two lines, at the top of the README with the most important stuff. How to install it.

It might be obvious to you, a python developer, but not for a potential end user. Is it using "pip install xyz" ? Will it work with pipx ? Are there any "official" packages for Linux distro xyz ?

Thanks in advance.

[m040601]

This is what I did on Arch Linux to quickly test it out:

python -m venv testing_pystitcher

cd ./testing_pystitcher

source bin/activate

pip install pypdf3

pip install pystitcher

[captn3m0]

Can you see if this looks good: https://github.com/captn3m0/pystitcher/wiki/Installation

I'll put a link in the README.

[m040601]

pipx install pystitcher

I had actually tried pipx as well. But failed because I misspelled "pystitcher" for "pysticher" and it failed.

Tested it again and it worked fine. Pipx is a great and clean option , if pystitcher is not packaged for your system, and you dont want to "pollute it" with a system wide "pip install".

Can you see if this looks good

Yes it does. Just add the "--user" advice. Much cleaner. Read the docs.

From:

You can use pip to install pystitcher: pip install pystitcher

to someting like:

You can use pip to install pystitcher: pip install pystitcher (system wide) pip install --user pystitcher (user)

[m040601]

pystitcher is not packaged for any distributions yet.

We'll try to get one for Arch Linux https://aur.archlinux.org/packages/stapler/#comment-818115

[captn3m0]

I'm on Arch as well, I might get around to it or if you do push it to AUR, please add me as maintainer.