Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1050

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #1050

wants to merge 2 commits into from

Conversation

thePanz
Copy link

@thePanz thePanz commented Oct 13, 2023

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

Document how to override the default configurations by using `~/.config/paru/paru.conf`
@Morganamilo
Copy link
Owner

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.

@thePanz
Copy link
Author

thePanz commented Oct 13, 2023

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?

@Morganamilo
Copy link
Owner

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.

@thePanz
Copy link
Author

thePanz commented Oct 13, 2023

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

@Morganamilo
Copy link
Owner

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

@thePanz
Copy link
Author

thePanz commented Oct 17, 2023

sure! I will update this PR later on

@soloturn
Copy link
Contributor

@thePanz you want to cancel the pr,?

@thePanz
Copy link
Author

thePanz commented Feb 26, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants