Compacted build instructions a bit.
This commit is contained in:
parent
23aae490df
commit
f48d480c77
20
README.md
20
README.md
@ -158,7 +158,7 @@ For example:
|
|||||||
./build && sudo ./install
|
./build && sudo ./install
|
||||||
mpw -h
|
mpw -h
|
||||||
|
|
||||||
Normally, this is all you need to do, however note that there are a few dependencies that need to be met, depending on which targets you are building:
|
Normally, this is all you need to do, however note that there are a few dependencies that need to be met, depending on which targets you are building (by default, only the `mpw` target is built):
|
||||||
|
|
||||||
- `mpw`
|
- `mpw`
|
||||||
|
|
||||||
@ -176,28 +176,24 @@ This tool compares the performance of a few cryptographic algorithms, including
|
|||||||
|
|
||||||
This tool runs a suite of tests to ensure the correct passwords are being generated by the algorithm under various circumstances. The test suite is declared in `mpw-tests.xml` which needs to exist in the current working directory when running the tool. In addition, `libxml2` is used to parse the file, so this target depends on you having it installed when running `./build`.
|
This tool runs a suite of tests to ensure the correct passwords are being generated by the algorithm under various circumstances. The test suite is declared in `mpw-tests.xml` which needs to exist in the current working directory when running the tool. In addition, `libxml2` is used to parse the file, so this target depends on you having it installed when running `./build`.
|
||||||
|
|
||||||
Finally, there are a few different ways you can modify the build process:
|
|
||||||
|
|
||||||
- You can change the targets that should be built. By default, only `mpw` is built. These are the available targets:
|
Finally, there are a few different ways you can modify the build process.
|
||||||
- `mpw`: This is the standard command-line `mpw` tool which implements all Master Password features.
|
|
||||||
- `mpw-tests`: This is a tool to perform the standard tests script on the `mpw` implementation.
|
|
||||||
- `mpw-bench`: This is a tool to run a benchmark on the `mpw` implementation, comparing it to the performance of other algorithms.
|
|
||||||
- You can specify custom arguments to the compiler, pass them as arguments to the build script.
|
|
||||||
- The build process involves some optionals, they can by toggled from their default setting by passing variables:
|
|
||||||
- `mpw_color`: [default: 1] Colorized Identicon, depends on
|
|
||||||
|
|
||||||
To change the targets to build, use:
|
To build additional targets, set the `targets` environment variable:
|
||||||
|
|
||||||
targets='mpw mpw-tests' ./build
|
targets='mpw mpw-tests' ./build
|
||||||
|
|
||||||
To add a library search path, use:
|
To pass additional compiler arguments, eg. add a library search path, pass them as arguments to the script:
|
||||||
|
|
||||||
./build -L/usr/local/lib
|
./build -L/usr/local/lib
|
||||||
|
|
||||||
Change an optional feature:
|
There are a few toggleable features, to change them, pass them as environment variables:
|
||||||
|
|
||||||
mpw_color=0 ./build
|
mpw_color=0 ./build
|
||||||
|
|
||||||
|
Currently, there is only one toggleable feature:
|
||||||
|
|
||||||
|
- `mpw_color`: [default: 1] Colorized Identicon, depends on `ncurses-dev`.
|
||||||
|
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
Loading…
Reference in New Issue
Block a user