diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,13 +1,57 @@ -# Falkon Web Browser +# 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. +![image](https://www.falkon.org/images/screenshot.png) -QtWebEngine web browser. +## 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. -## Building +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 +```sh +$ git clone git://anongit.kde.org/falkon.git +``` Falkon uses CMake, to build it run: +```sh +$ mkdir build && cd build +$ cmake .. +$ make +$ sudo make install +``` +To run Falkon +```sh +$ cd bin +$ ./falkon ``` -mkdir build && cd build -cmake .. -make +## 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 +```sh +$ cmake -DCMAKE_PREFIX_PATH=/path/to/Qt/5.12.2/gcc_64 .. ``` +## Contributing +Want to contribute? Great! + + +Code review is done on [Phabricator](https://community.kde.org/Infrastructure/Phabricator). When sending patches, add Falkon project (`#Falkon`) as a reviewer. + +#### Reporting bugs + +You can report any bugs or feature request in KDE [bugzilla](https://bugs.kde.org/enter_bug.cgi?product=Falkon). Before reporting, please make sure your issue isn’t already reported ([open issues](https://bugs.kde.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=ASSIGNED&bug_status=REOPENED&component=extensions&component=general&list_id=1597725&product=Falkon)). +#### Contact + +You can get in contact with developers using [mailing list](https://mail.kde.org/mailman/listinfo/falkon) or __IRC__ `#falkon` at `chat.freenode.net`. + + +