From 8a7d4c782a01fdb992d9d73b7114de6219461007 Mon Sep 17 00:00:00 2001 From: Nicholas Tay Date: Fri, 14 Jan 2022 00:30:02 +1100 Subject: Update readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fad1c8d..02fbb47 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,13 @@ Just a password generator that makes [passwds.ninja](https://passwds.ninja/)-style passwords. -Heavily inspired by a generator I used before at work, just that this time in C. (This is my first C project, please be gentle...) +Heavily inspired by a generator I used before at work (in Python), just that this time in C. + +As such, it utilises 'grammars' of character classes, which can be efficiently be mixed and matched on the fly, and/or the grammars themselves being able to be easily customised at compile-time. + +See `passgen --help` for details. + +(This is my first C project, please be gentle... some of the decisions I made may look weird or seem like I'm going out of my way to do something - some of these are done intentionally as a way for me to familiarise myself more with the features of the language.) ## Compiling @@ -14,6 +20,8 @@ $ make $ cl /std:c11 passgen.c /link Advapi32.lib ``` +NOTE: Compilation with mingw will use the fallback RNG for password generation. This utilises `rand()` in C, seeded with the time and PID - may be unsafe! On Windows with `cl`, \*nix, macOS, Free/OpenBSD, the relevant system calls will be utilised to get better quality randomness. See the `_rng` functions for details. + ## Licence Zlib -- cgit