aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNicholas Tay <nick@windblume.net>2022-01-14 00:30:02 +1100
committerNicholas Tay <nick@windblume.net>2022-01-14 00:30:02 +1100
commit8a7d4c782a01fdb992d9d73b7114de6219461007 (patch)
treeb330a3f5f31661e3ed7a33a82d6989de7fc0cc37 /README.md
parenta2f5bce2bd1e462f9cd26d3278ff7dd355bf9540 (diff)
downloadpassgen-8a7d4c782a01fdb992d9d73b7114de6219461007.tar.gz
passgen-8a7d4c782a01fdb992d9d73b7114de6219461007.tar.bz2
passgen-8a7d4c782a01fdb992d9d73b7114de6219461007.zip
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
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