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

Improve documentation and provide a sample configuration file #12

Open
bknowles opened this issue Aug 12, 2015 · 3 comments
Open

Improve documentation and provide a sample configuration file #12

bknowles opened this issue Aug 12, 2015 · 3 comments
Milestone

Comments

@bknowles
Copy link

So, I want to provide my own dictionary. And I want my own version of a password preset. In fact, I want to be able to create multiple presets of my own.

But I have no idea what a configuration file should look like, or how I would put it somewhere that it would get used by default.

The Perl POD documentation is pretty extensive, but I'd like to see more of that brought into the man page and into the README.md file for this repo. But even the Perl POD documentation doesn't show me how to create a configuration file or where I could put it so that it would get used by default.

@bbusschots bbusschots added this to the Version 3.7 milestone Aug 12, 2015
@bbusschots
Copy link
Owner

@bknowles - until I get a chance to update the docs, there is a sample config file included in the share folder of the distro: https://github.com/bbusschots/hsxkpasswd/blob/master/share/sample_hsxkpasswdrc

@bknowles
Copy link
Author

Cool. I'll take a look. Thanks!

@et304383
Copy link

+1 on adding an example configuration file to the readme.

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

No branches or pull requests

3 participants