From f48d480c77dda03e001593373fe3c6dc914ac484 Mon Sep 17 00:00:00 2001 From: Maarten Billemont Date: Fri, 14 Apr 2017 09:01:04 -0400 Subject: [PATCH] Compacted build instructions a bit. --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3f0a2c66..255ba13d 100644 --- a/README.md +++ b/README.md @@ -158,7 +158,7 @@ For example: ./build && sudo ./install 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` @@ -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`. -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: - - `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 +Finally, there are a few different ways you can modify the build process. -To change the targets to build, use: +To build additional targets, set the `targets` environment variable: 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 -Change an optional feature: +There are a few toggleable features, to change them, pass them as environment variables: mpw_color=0 ./build +Currently, there is only one toggleable feature: + + - `mpw_color`: [default: 1] Colorized Identicon, depends on `ncurses-dev`. ## Support