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

Configuration defaults #606

Open
rizsotto opened this issue Nov 10, 2024 · 0 comments
Open

Configuration defaults #606

rizsotto opened this issue Nov 10, 2024 · 0 comments

Comments

@rizsotto
Copy link
Owner

rizsotto commented Nov 10, 2024

This ticket is about the rust code.

The new configuration of the Bear program is more complex than before. It has module documentation (and probably will have man page too) to explain the possibilities to users. But the configuration is optional. If the configuration file is not given, the program is using sane default values.

The challenges I would like to solve:

  • How users will know what the default configuration is?
  • How can they quickly have a configuration file?

Ideas to evaluate as possible fix for the problem:

  • the --help-config shows the current defaults. And it shows in YAML format (so it's easy to use as a starting point)
  • the project deploys a default config file as template (with a lot of comments included)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant