diff --git a/README.md b/README.md index 321f8b601..47c59a3d5 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,89 @@ Translations: [https://www.transifex.com](https://www.transifex.com/projects/p/q THIS IS QTWEBENGINE BRANCH ---------------------------------------------------------------------------------------- -Master branch is now for QtWebEngine (>= 5.6). It is still in very early development state, -so expect a lot of features found in QtWebKit branch not working here. Thanks for understanding! +Master branch is now for QtWebEngine (>= 5.6). For QtWebEngine (= 5.5), please use [qt5.5](https://github.com/QupZilla/qupzilla/tree/qt5.5) -For QtWebKit, please use [v1.8](https://github.com/QupZilla/qupzilla/tree/v1.8) \ No newline at end of file +For QtWebKit, please use [v1.8](https://github.com/QupZilla/qupzilla/tree/v1.8) + +About QupZilla +---------------------------------------------------------------------------------------- + +QupZilla is a new and very fast QtWebEngine browser. It aims to be a lightweight web browser +available through all major platforms. This project has been originally started only +for educational purposes. But from its start, QupZilla has grown into a feature-rich browser. + +QupZilla has all standard functions you expect from a web browser. It includes bookmarks, +history (both also in sidebar) and tabs. Above that, it has by default enabled blocking ads +with a built-in AdBlock plugin. + +History +---------------------------------------------------------------------------------------- + +The very first version of QupZilla has been released in December 2010 and it was written +in Python with PyQt4 bindings. After a few versions, QupZilla has been completely rewritten +in C++ with the Qt Framework. The Windows version of QupZilla was compiled using MingW, but due to +a huge problem with Flash, it is now compiled with Microsoft Visual C++ Compiler 2008. +First public release was 1.0.0-b4. + +Until version 2.0, QupZilla was using QtWebKit. QtWebKit is now deprecated and new versions +are using QtWebEngine. + +Compiling +---------------------------------------------------------------------------------------- + +Before you start compiling, make sure that you have installed the Qt (>= 5.6) development libraries +and you have read the [BUILDING](https://github.com/QupZilla/qupzilla/blob/master/BUILDING) information. + +**Linux** + + * OpenSSL (libcrypto) is required + * xcb libraries when building without NO_X11 + +**Windows** + * OpenSSL (libeay32) is required + +Then you can start compiling by running this commands: + + $ qmake + $ make + +After a successful compilation the executable binary can be found in the bin/ directory. +On Fedora and possibly other Linux distributions you need to replace `qmake` with `qmake-qt5`. + +On Linux/Unix: To install QupZilla, run this command: (it may be necessary to run it as root) + + $ make install + +On Mac OS X: To deploy QupZilla in dmg image, run this command: + + $ ./mac/macdeploy.sh full-path-to-macdeployqt + +You need to specify path to `macdeployqt` only if it is not in PATH. + +Current version +---------------------------------------------------------------------------------------- + +The current stable version of QupZilla is 1.8.6. You can download precompiled packages +and the sources from the download section at [homepage](http://www.qupzilla.com/download). +However, if you want the latest revision, just take the latest code snapshot either by +downloading a tarball or running: + + $ git clone git://github.com/QupZilla/qupzilla.git + +If you are using Ubuntu, you can download QupZilla from PPA: + + $ sudo add-apt-repository ppa:nowrep/qupzilla + $ sudo apt-get update + $ sudo apt-get install qupzilla + + for development version: + + $ sudo apt-get install qupzilla-next + +FAQ and Changelog +---------------------------------------------------------------------------------------- + +If you are experiencing some sort of problem, please read the FAQ before you open an issue. + +[FAQ](https://github.com/QupZilla/qupzilla/wiki/FAQ) | [Changelog](https://github.com/QupZilla/qupzilla/blob/master/CHANGELOG) | [Bug Reports](https://github.com/QupZilla/qupzilla/wiki/Bug-Reports) \ No newline at end of file