skylab/MasterPassword
2
0
Fork 0
Code Releases Activity

Some style fixes to README

Browse Source
This commit is contained in:
Maarten Billemont 2017-03-29 00:32:15 -04:00
parent 93cdcc1743
commit 77b095e25e
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -153,17 +153,22 @@ Go into the `platform-independent/cli-c` directory and run `./build`. The nativ
When the build completes, you will have an `mpw` binary you can use. You can copy it into your `PATH` or use the `./install` script to help you do so. When the build completes, you will have an `mpw` binary you can use. You can copy it into your `PATH` or use the `./install` script to help you do so.
For example:
sudo ./install
mpw -h
The build has a few dependencies you should have installed before running it: The build has a few dependencies you should have installed before running it:
- `mpw`: openssl-dev, ncurses-dev (if `mpw_color=1`) - `mpw`: `openssl-dev`, `ncurses-dev` (if `mpw_color=1`)
- `mpw-bench`: openssl-dev - `mpw-bench`: `openssl-dev`
- `mpw-tests`: openssl-dev, libxml2 - `mpw-tests`: `openssl-dev`, `libxml2`
There are a few different ways you can modify the build process: There are a few different ways you can modify the build process:
- You can change the targets that should be built. By default, all targets are built. These are the available targets: - You can change the targets that should be built. By default, all targets are built. These are the available targets:
- `mpw`: This is the standard command-line `mpw` tool which implements all Master Password features. - `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 test script on the `mpw` implementation. - `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. - `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. - 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: - The build process involves some optionals, they can by toggled from their default setting by passing variables:

2
platform-independent/cli-c/install
View File

@ -23,7 +23,7 @@ bindir=$(ask -d "$bindir" "What bin directory should I install to?")
[[ -w "$bindir" ]] || ftl 'Cannot write to bin directory: %s' "$bindir" || exit [[ -w "$bindir" ]] || ftl 'Cannot write to bin directory: %s' "$bindir" || exit
# Install Master Password. # Install Master Password.
install mpw "$bindir" install -m555 mpw "$bindir"
[[ ! -e "$bindir/bashlib" ]] && install bashlib "$bindir" ||: [[ ! -e "$bindir/bashlib" ]] && install bashlib "$bindir" ||:
# Convenience bash function. # Convenience bash function.