1
mirror of https://invent.kde.org/network/falkon.git synced 2024-12-21 03:06:34 +01:00
falkonOfficial/README.md

78 lines
3.4 KiB
Markdown
Raw Normal View History

2016-03-30 14:50:03 +02:00
QupZilla Web Browser
----------------------------------------------------------------------------------------
[![Build Status](https://travis-ci.org/QupZilla/qupzilla.svg?branch=master)](https://travis-ci.org/QupZilla/qupzilla)
Homepage: [http://www.qupzilla.com](http://www.qupzilla.com)
Blog: [http://blog.qupzilla.com](http://blog.qupzilla.com)
IRC: `#qupzilla` at `irc.freenode.net`
Translations: [https://www.transifex.com](https://www.transifex.com/projects/p/qupzilla)
2011-10-15 13:17:20 +02:00
2017-01-21 21:13:49 +01:00
![](https://github.com/QupZilla/qupzilla/blob/master/src/lib/data/icons/other/about.png?raw=true)
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
2017-01-21 21:15:53 +01:00
in C++ with the Qt Framework. 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
----------------------------------------------------------------------------------------
2016-10-24 20:11:50 +02:00
Before you start compiling, make sure that you have installed the Qt (>= 5.7) development libraries
Mac: Repair current OpenSSL undefined reference from homebrew to dynamic (#1971) * Repair current OpenSSL static reference from homebrew * These are the default locations, as of today, for Mac OS X 10.11.4 *(El Capitan)* **NOTES** * This could really use some environment variables for homebrew root and which SSL version is in use. Not familiar enough yet with recent Qt to do this at this time. * Symbolic links could also be used but again determining the current homebrew SSL installed is something to be desired e.g. similar to `$ openssl version` e.g. perhaps a `cut` of `$ brew info openssl`? Refs: * http://brew.sh/ *(homepage)* * https://github.com/Homebrew/brew *(repo)* Historical refs: * #1888 * #1850 * Mac: Scrape `brew` output for openssl working install directory as per @nowrep * Addresses a long standing bug on Mac compiling with this project * Also correct the BUILDING markdown file for OS X... was awaiting response from the owner to do this to see which direction to move. **NOTES** * Quotes **are required** when using `$$system` here otherwise `cut` fails with no switch argument found Applies to #1971 * Fix BUILDING to BUILDING.md * Do this so it actually parses markdown Indirectly related to #1971 * Fix `brew` to Homebrew * Even though the project is named `brew` and owner is `Homebrew` their pages refers to it as `Homebrew` Applies to #1971 * Yet another change * There are more symlinks... so the results from `brew --prefix openssl` yields a symlinked path and adding `/include` and `/lib` to them resolve alternately to the `Cellar`. Feel **much** better about using this one since it's an exact API as I mentioned earlier in the PR Applies to #1971 * Add a single newline for @cranes-bill * Only one newline is needed and has nothing to do with trailing spaces... at least according to the GH editor * Restores the flow :) Applies to #1971 * More flow of README.md * GH preview said it didn't need this but I guess it does... we'll try newlines everywhere ;) Applies to #1971 * Use non-standard markdown for "newlines" * Restore the spaces manually **NOTES** This is not any known specification but it's what @nowrep wants Refs: * [CommonMark](http://commonmark.org/) * [Daring Fireballs](http://daringfireball.net/projects/markdown/)
2016-05-14 12:45:28 +02:00
and you have read the [BUILDING.md](https://github.com/QupZilla/qupzilla/blob/master/BUILDING.md) 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
----------------------------------------------------------------------------------------
2016-10-24 17:35:49 +02:00
The current stable version of QupZilla is 2.0.2. 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
FAQ and Changelog
----------------------------------------------------------------------------------------
If you are experiencing some sort of problem, please read the FAQ before you open an issue.
2015-11-12 16:40:50 +01:00
[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)