Install desktop file and icons to DATADIR instead of the hardcoded share/.
[keepassx:keepassx.git] / README.md
1 # KeePassX
2
3 ## About
4
5 KeePassX is an application for people with extremely high demands on secure personal data management.
6 It has a light interface, is cross platform and published under the terms of the GNU General Public License.
7
8 KeePassX saves many different information e.g. user names, passwords, urls, attachments and comments in one single database.
9 For a better management user-defined titles and icons can be specified for each single entry.
10 Furthermore the entries are sorted in groups, which are customizable as well. The integrated search function allows to search in a single group or the complete database.
11 KeePassX offers a little utility for secure password generation. The password generator is very customizable, fast and easy to use.
12 Especially someone who generates passwords frequently will appreciate this feature.
13
14 The complete database is always encrypted with the AES (aka Rijndael) encryption algorithm using a 256 bit key.
15 Therefore the saved information can be considered as quite safe. KeePassX uses a database format that is compatible with [KeePass Password Safe](http://keepass.info/).
16 This makes the use of that application even more favorable.
17
18 ## Install
19
20 KeePassX can be downloaded and installed using an assortment of installers available on the main [KeePassX website](http://www.keepassx.org).
21 KeePassX can also be installed from the official repositories of many Linux repositories.
22 If you wish to build KeePassX from source, rather than rely on the pre-compiled binaries, you may wish to read up on the _From Source_ section.
23
24 ### Debian
25
26 To install KeePassX from the Debian repository:
27
28 ```bash
29 sudo apt-get install keepassx
30 ```
31
32 ### Red Hat
33
34 Install KeePassX from the Red Hat (or CentOS) repository:
35
36 ```bash
37 sudo yum install keepassx
38 ```
39
40 ### Windows / Mac OS X
41
42 Download the installer from the KeePassX [download](https://www.keepassx.org/downloads) page.
43 Once downloaded, double click on the file to execute the installer.
44
45 ### From Source
46
47 #### Build Dependencies
48
49 The following tools must exist within your PATH:
50
51 * make
52 * cmake (>= 2.6.4)
53 * g++ or clang++
54
55 The following libraries are required:
56
57 * Qt 4 (>= 4.6)
58 * libgcrypt
59 * zlib
60
61 On Debian you can install them with:
62
63 ```bash
64 sudo apt-get install build-essential cmake libqt4-dev libgcrypt11-dev zlib1g-dev
65 ```
66
67 #### Build Steps
68
69 To compile from source:
70
71 ```bash
72 mkdir build
73 cd build
74 cmake ..
75 make [-jX]
76 ```
77
78 You will have the compiled KeePassX binary inside the `./build/src/` directory.
79
80 To install this binary execute the following:
81
82 ```bash
83 sudo make install
84 ```
85
86 More detailed instructions available in the INSTALL file.
87
88 ## Contribute
89
90 Coordination of work between developers is handled through the [KeePassX development](https://www.keepassx.org/dev/) site.
91 Requests for enhancements, or reports of bugs encountered, can also be reported through the KeePassX development site.
92 However, members of the open-source community are encouraged to submit pull requests directly through GitHub.
93
94 ### Clone Repository
95
96 Clone the repository to a suitable location where you can extend and build this project.
97
98 ```bash
99 git clone https://github.com/keepassx/keepassx.git
100 ```
101
102 **Note:** This will clone the entire contents of the repository at the HEAD revision.
103
104 To update the project from within the project's folder you can run the following command:
105
106 ```bash
107 git pull
108 ```
109
110 ### Feature Requests
111
112 We're always looking for suggestions to improve our application. If you have a suggestion for improving an existing feature,
113 or would like to suggest a completely new feature for KeePassX, please file a ticket on the [KeePassX development](https://www.keepassx.org/dev/) site.
114
115 ### Bug Reports
116
117 Our software isn't always perfect, but we strive to always improve our work. You may file bug reports on the [KeePassX development](https://www.keepassx.org/dev/) site.
118
119 ### Pull Requests
120
121 Along with our desire to hear your feedback and suggestions, we're also interested in accepting direct assistance in the form of code.
122
123 Issue merge requests against our [GitHub repository](https://github.com/keepassx/keepassx).
124
125 ### Translations
126
127 Translations are managed on [Transifex](https://www.transifex.com/projects/p/keepassx/) which offers a web interface.
128 Please join an existing language team or request a new one if there is none.