Documentation rework

[samuel-jimenez]

What are your thoughts on splitting up the documentation?

I wonder if it might flow better if, instead of one monolithic readme, it is split into more context-appropriate sections?

Maybe something akin to pacman's strategy, where you can man pacman to get basic operation and command-line arguments, but man pacman.conf will tell about the config file?

[actionless]

yup, would make sense 👍

[actionless]

(but don't do it as part of your current PR)

[samuel-jimenez]

Here are my thoughts for the process. Clearly GitHub uses README.md, so that file needs to be kept.

1. Split the Configuration section of the current readme to be accessed by man pikaur.conf
2. Could args.py be leveraged to produce man pikaur?
3. Access to the readme through man pikaur.install or something similar

[samuel-jimenez]

Sounds good. One thing: --help with no operation will not list any options. Is this intentional behavior?

[actionless]

did you checked pacman?

[samuel-jimenez]

Right, but pacman enumerates top-level options in the man page.

[actionless]

that's a different matter:
in the manpage pacman options have much longer description for each option than in pacman --help

[actionless]

and top-level flags (ie not options) unique to pikaur (-P and -G) are documented in its manpage