-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/develop' into feature/merge-db-#22
# Conflicts: # src/gui/MainWindow.cpp
- Loading branch information
Showing
17 changed files
with
228 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,101 @@ | ||
Building: | ||
========= | ||
Install KeePassXR | ||
================= | ||
|
||
This document will guide you across the steps to install KeePassXR. | ||
You can visit the online version of this document a the following link | ||
|
||
https://github.com/keepassxreboot/keepassx/wiki/Install-Instruction-from-Source | ||
|
||
|
||
Build Dependencies | ||
================== | ||
|
||
The following tools must exist within your PATH: | ||
|
||
* make | ||
* cmake (>= 2.8.12) | ||
* g++ (>= 4.7) or clang++ (>= 3.0) | ||
|
||
The following libraries are required: | ||
|
||
* Qt 5 (>= 5.2): qtbase and qttools5 | ||
* libgcrypt (>= 1.6) | ||
* zlib | ||
* libmicrohttpd | ||
* libxi, libxtst, qtx11extras (optional for auto-type on X11) | ||
|
||
|
||
Prepare the Building Environment | ||
================================ | ||
|
||
Building Environment on Linux ==> https://github.com/keepassxreboot/keepassx/wiki/Building-Environment-on-Linux | ||
Building Environment on Windows ==> https://github.com/keepassxreboot/keepassx/wiki/Building-Environment-on-Windows | ||
Building Environment on MacOS ==> https://github.com/keepassxreboot/keepassx/wiki/Building-Environment-on-MacOS | ||
|
||
|
||
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 | ||
|
||
Navigate to the path you have downloaded KeePassXR and type these commands: | ||
|
||
``` | ||
mkdir build | ||
cd build | ||
cmake [CMAKE PARAMETERS] .. | ||
make [-jX] | ||
cmake -DWITH_TESTS=OFF | ||
make | ||
``` | ||
|
||
**Note:** If you are on MacOS you must add this parameter to **Cmake**, with the Qt version you have installed<br/> `-DCMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.6.2/lib/cmake/` | ||
|
||
Common cmake parameters: | ||
======================== | ||
You will have the compiled KeePassXR binary inside the `./build/src/` directory. | ||
|
||
Common cmake parameters | ||
``` | ||
-DCMAKE_INSTALL_PREFIX=/usr/local | ||
-DCMAKE_VERBOSE_MAKEFILE=ON | ||
-DCMAKE_BUILD_TYPE=<RelWithDebInfo/Debug/Release> | ||
-DWITH_GUI_TESTS=ON | ||
``` | ||
|
||
Installing: | ||
=========== | ||
make install [DESTDIR=X] | ||
|
||
Create a bundle on Mac: | ||
Installation | ||
============ | ||
|
||
To install this binary execute the following: | ||
|
||
```bash | ||
sudo make install | ||
``` | ||
|
||
You can specify the destination dir with | ||
``` | ||
DESTDIR=X | ||
``` | ||
|
||
|
||
Packaging | ||
========= | ||
|
||
You can create a package to redistribute KeePassXR (zip, deb, rpm, dmg, etc..) | ||
``` | ||
make package | ||
``` | ||
|
||
|
||
Testing | ||
======= | ||
|
||
Run tests: | ||
========== | ||
make test [CTEST_OUTPUT_ON_FAILURE=1] [ARGS+=-jX] [ARGS+="-E testgui"] | ||
You can perform test on the executable | ||
``` | ||
make test | ||
``` | ||
|
||
OS specific instructions: | ||
========================= | ||
https://www.keepassx.org/dev/projects/keepassx/wiki/Install_instructions | ||
Common parameters: | ||
``` | ||
CTEST_OUTPUT_ON_FAILURE=1 | ||
ARGS+=-jX | ||
ARGS+="-E testgui" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.