diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,16 +1,13 @@ # Falkon -__Falkon__ (formerly QupZilla) is a free and open-source web browser. It is built on the Qt WebEngine which is a wrapper for the Chromium browser core. +__Falkon__ is a KDE web browser & It is built on the QtWebEngine. ![image](https://www.falkon.org/images/screenshot.png) -## Introduction -__Falkon__ is a KDE web browser using QtWebEngine rendering engine, previously known as QupZilla. 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, Falkon has grown into a feature-rich browser. - -Falkon 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. ## Downloads To download Falkon [click here](https://www.falkon.org/download/). ## Building From Source +Clone it locally using: ```sh $ git clone git://anongit.kde.org/falkon.git ``` @@ -19,33 +16,26 @@ ```sh $ mkdir build && cd build $ cmake .. -$ make -$ sudo make install -``` -To run Falkon -```sh -$ cd bin -$ ./falkon +$ make && make install ``` + ## Dependencies -- gcc -- cmake -- QT 5 -- libxcb-util-dev -- extra-cmake-modules -- libssl-dev - -`Note:`If you have installed QT externally -then you need to specify its path insted of `cmake ..` put +- CMake (Extra CMake Modules) +- XcbUtil (on Linux and only when not building with NO_X11) +- OpenSSL +- Qt 5 + +## Install into custom prefix ```sh -$ cmake -DCMAKE_PREFIX_PATH=/path/to/Qt/5.12.2/gcc_64 .. +$ cmake -DCMAKE_INSTALL_PREFIX=/some/path +$ XDG_DATA_DIRS="/some/path:$XDG_DATA_DIRS" falkon ``` ## Contributing + Want to contribute? Great! [KDE Community Wiki](https://community.kde.org/Get_Involved) - Code review is done on [Phabricator](https://community.kde.org/Infrastructure/Phabricator). When sending patches, add Falkon project (`#Falkon`) as a reviewer. #### Reporting bugs