1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
From: Sean Whitton <spwhitton@spwhitton.name>
Date: Sat, 24 Sep 2016 13:46:46 -0700
Subject: patch README for Debian
Remove build instructions, and functions for when zxcvbn-c ws compiled
with USE_DICT_FILE (see README.source).
Forwarded: not-needed
---
README.md | 29 +----------------------------
1 file changed, 1 insertion(+), 28 deletions(-)
diff --git a/README.md b/README.md
index 1fe31e7..9868fff 100644
--- a/README.md
+++ b/README.md
@@ -11,42 +11,15 @@ The original CoffeeScript version is available at
An article on the reasons for zxcvbn is at
https://blogs.dropbox.com/tech/2012/04/zxcvbn-realistic-password-strength-estimation/
-## Building
-
-The makefile will build several test programs to test the code. It shows the steps needed
-to use the code in C and C++ programs, using the dictionary data read from file or included
-within the program executable.
-The makefile has only been tried on Linux using GCC version 4.8.4, but should be fairly
-portable to other systems.
-
-When dictionary data is included in your program's executable, the files `zxcvbn.c` ,
-`zxcvbn.h` , `dict-src.h` are used in your program.
-
-When dictionary data is read from file, the files `zxcvbn.c` , `zxcvbn.h` , `dict-crc.h`
-and `zxcvbn.dict` are used in your program, compiled with `#define USE_DICT_FILE`. The CRC
-of the dictionary data file is written to `dict-crc.h` so your executable can detect
-corruption of the data.
-
-Rename `zxcvbn.c` to `zxcvbn.cpp` (or whatever your compiler uses) to compile as C++.
-
-The `dict*.h` and `zxcvbn.dict` files are generated by the dictgen program compiled from
-dict-generate.cpp (see makefile for details).
-
## Using
-Initially call `ZxcvbnInit()` with the pathname of the `zxcvbn.dict` file. This can be
-omitted when dictionary data is included in the executable.
-
Call `ZxcvbnMatch()` with the password and optional user dictionary to get the entropy
estimation and optional information on the password parts (which will need freeing with
`ZxcvbnFreeInfo()` after use). Do this for each password to be tested, or as each character
of it is entered into your program. The optional user dictionary can change between each
call.
-Finally call `ZxcvbnUninit()` to free the dictionary data from read from file. This can be
-omitted when dictionary data is included in the executable.
-
-Review the test program in `test.c` for an example.
+Review the test program in `examples/test.c` for an example.
## Differences from the original version
|
