hsxkpasswd icon indicating copy to clipboard operation
hsxkpasswd copied to clipboard

Improve documentation and provide a sample configuration file

Open bknowles opened this issue 9 years ago • 3 comments

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.

bknowles avatar Aug 12 '15 06:08 bknowles

@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

bbusschots avatar Aug 13 '15 22:08 bbusschots

Cool. I'll take a look. Thanks!

bknowles avatar Aug 15 '15 15:08 bknowles

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

et304383 avatar Nov 14 '15 17:11 et304383