paru icon indicating copy to clipboard operation
paru copied to clipboard

Update README.md

Open thePanz opened this issue 2 years ago • 8 comments

Document how to override the default configurations by using ~/.config/paru/paru.conf

thePanz avatar Oct 13 '23 07:10 thePanz

Theres already a man page for the config file. I expect users to know how a config files generally work as well.

Plus I don't expect most users to come to this page to install paru as they'd get it through package management.

Morganamilo avatar Oct 13 '23 08:10 Morganamilo

I agree, the man pages already defines how the paru.conf file is expected to be found and used

The missing point for me was: did not know that paru was using a config file!

Would it make sense to add a note about it (for the distracted users like me)? wdyt?

thePanz avatar Oct 13 '23 08:10 thePanz

The mention of the config fine is mentioned in the main man page. If people don't check that I doubt an online readme will help.

Morganamilo avatar Oct 13 '23 09:10 Morganamilo

Fair enough, even if I strongly suggest to have a mention online: this would be the first place to know the features offered by the tool (before installing).

I noticed that other tools (https://github.com/BurntSushi/ripgrep/blob/master/GUIDE.md#configuration-file) mentions that on the online documentation. While rg does not provide a manpage for their ripgreprc configuration tho

thePanz avatar Oct 13 '23 09:10 thePanz

If you just want the config file locations mentioned I think that would make sense.

Morganamilo avatar Oct 13 '23 11:10 Morganamilo

sure! I will update this PR later on

thePanz avatar Oct 17 '23 12:10 thePanz

@thePanz you want to cancel the pr,?

soloturn avatar Feb 25 '24 17:02 soloturn

@soloturn thanks for the headsup! I updated the PR now, with the latest comments from @Morganamilo

thePanz avatar Feb 26 '24 07:02 thePanz