From 6ac773d5ae0bb4dd9cc4bbd9b0a8f76eadddb9e2 Mon Sep 17 00:00:00 2001 From: Jonathan White Date: Wed, 5 Oct 2016 23:03:13 -0400 Subject: [PATCH] Updated readme file --- .gitignore | 2 +- README.md | 24 ++++++++++++++++-------- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 2e9cb860c..081abf831 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ CMakeLists.txt.* -build/ +build*/ diff --git a/README.md b/README.md index c97c408d5..70f320138 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ -# KeePassX v2.0.2 + keepasshttp +# KeePassX Reboot -![alt text](https://travis-ci.org/keepassxreboot/keepassx.svg?branch=master "Travis-CI Badge") +[![Travis Build Status](https://travis-ci.org/keepassxreboot/keepassx.svg?branch=master)](https://travis-ci.org/keepassxreboot/keepassx) [![Coverage Status](https://coveralls.io/repos/github/keepassxreboot/keepassx/badge.svg?branch=develop)](https://coveralls.io/github/keepassxreboot/keepassx?branch=develop) ## About Fork of [KeePassX](https://www.keepassx.org/) with keepasshttp support for use with [PassIFox](https://addons.mozilla.org/en-us/firefox/addon/passifox/) for Mozilla Firefox and [chromeIPass](https://chrome.google.com/webstore/detail/chromeipass/ompiailgknfdndiefoaoiligalphfdae) for Google Chrome. -KeePassHttp implementation has been forked from jdachtera's repository, which in turn was based on code from code with Francois Ferrand's [keepassx-http](https://gitorious.org/keepassx/keepassx-http/source/master:) repository. +KeePassHttp implementation has been forked from jdachtera's repository, which in turn was based on code from code with Francois Ferrand's [keepassx-http](https://gitorious.org/keepassx/keepassx-http/source/master) repository. -This is a rebuild from [denk-mal's keepasshttp](https://github.com/denk-mal/keepassx.git) that brings it forward to Qt5 and KeePassX v2.0.2. +This is a rebuild from [denk-mal's keepasshttp](https://github.com/denk-mal/keepassx.git) that brings it forward to Qt5 and KeePassX v2.x. + +This reboot also aims to incorporate stalled Pull Requests, features, and bug fixes that are not being incorporated into the main KeePassX baseline. #### Build Dependencies @@ -26,12 +28,18 @@ The following libraries are required: * libmicrohttpd * libxi, libxtst, qtx11extras (optional for auto-type on X11) -On Debian you can install them with: +On Debian/Ubuntu you can install them with: ```bash sudo apt-get install build-essential cmake libmicrohttpd-dev libxi-dev qtbase5-dev libqt5x11extras5-dev qttools5-dev qttools5-dev-tools libgcrypt20-dev zlib1g-dev ``` +On Fedora/RHEL/CentOS you can install them with: + +```bash +sudo dnf install make automake gcc gcc-c++ cmake libmicrohttpd-devel libXi-devel qt5-qtbase-devel qt5-qtx11extras qt5-qttools libgcrypt-devel zlib-devel +``` + #### Build Steps To compile from source: @@ -78,17 +86,17 @@ git pull ### Feature Requests We're always looking for suggestions to improve our application. If you have a suggestion for improving an existing feature, -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. +or would like to suggest a completely new feature for KeePassX Reboot, please use the Issues section. ### Bug Reports -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. +Our software isn't always perfect, but we strive to always improve our work. You may file bug reports in the Issues section. ### Pull Requests Along with our desire to hear your feedback and suggestions, we're also interested in accepting direct assistance in the form of code. -Issue merge requests against our [GitHub repository](https://github.com/keepassxreboot/keepassx). +All pull requests must comply with the CONTRIBUTION requirements. ### Translations