diff options
| author | varjolintu <sami.vanttinen@protonmail.com> | 2017-12-12 11:15:23 +0300 |
|---|---|---|
| committer | Janek Bevendorff <janek@jbev.net> | 2018-01-04 23:42:20 +0300 |
| commit | 06518c57361f366d7d4b00fc9cb441dae57174c5 (patch) | |
| tree | 44373fe0eba4398a4cad67da4b3746cc3922d721 /INSTALL.md | |
| parent | a7e6e4ef45874b93cfdc53510fb7d32bb207e401 (diff) | |
keepassxc-browser
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/INSTALL.md b/INSTALL.md index 2d3f7cb2b..0bfa86b2c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -6,7 +6,7 @@ You can visit the online version of this document at the following link: https://github.com/keepassxreboot/keepassx/wiki/Install-Instruction-from-Source -The [KeePassXC QuickStart](./docs/QUICKSTART.md) gets you started using KeePassXC on your +The [KeePassXC QuickStart](./docs/QUICKSTART.md) gets you started using KeePassXC on your Windows, Mac, or Linux computer using the pre-built binaries. Build Dependencies @@ -25,6 +25,7 @@ The following libraries are required: * zlib * libmicrohttpd * libxi, libxtst, qtx11extras (optional for auto-type on X11) +* libsodium (>= 1.0.12, optional for keepassxc-browser support) Prepare the Building Environment @@ -40,7 +41,7 @@ Build Steps To compile from source, open a **Terminal (on Linux/MacOS)** or a **MSYS2-MinGW shell (on Windows)**<br/> **Note:** on Windows make sure you are using a **MINGW shell** by checking the label before the current path -First, download the KeePassXC [source tarball](https://keepassxc.org/download#source) +First, download the KeePassXC [source tarball](https://keepassxc.org/download#source) or check out the latest version from our [Git repository](https://github.com/keepassxreboot/keepassxc). To clone the project from Git, `cd` to a suitable location and run @@ -66,10 +67,10 @@ cd build cmake -DWITH_TESTS=OFF ...and other options - see below... make ``` -These steps place the compiled KeePassXC binary inside the `./build/src/` directory. +These steps place the compiled KeePassXC binary inside the `./build/src/` directory. (Note the cmake notes/options below.) -**Cmake Notes:** +**Cmake Notes:** * Common cmake parameters @@ -86,7 +87,8 @@ These steps place the compiled KeePassXC binary inside the `./build/src/` direct -DWITH_XC_AUTOTYPE=[ON|OFF] Enable/Disable Auto-Type (default: ON) -DWITH_XC_HTTP=[ON|OFF] Enable/Disable KeePassHTTP and custom icon downloads (default: OFF) -DWITH_XC_YUBIKEY=[ON|OFF] Enable/Disable YubiKey HMAC-SHA1 authentication support (default: OFF) - + -DWITH_XC_BROWSER=[ON|OFF] Enable/Disable keepassxc-browser extension support (default: OFF) + -DWITH_TESTS=[ON|OFF] Enable/Disable building of unit tests (default: ON) -DWITH_GUI_TESTS=[ON|OFF] Enable/Disable building of GUI tests (default: OFF) -DWITH_DEV_BUILD=[ON|OFF] Enable/Disable deprecated method warnings (default: OFF) |