diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,13 +1,49 @@ -# Falkon Web Browser +# Falkon +__Falkon__ is a KDE web browser & It is built on the QtWebEngine. +![image](https://www.falkon.org/images/screenshot.png) -QtWebEngine web browser. -## Building +## 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 +``` Falkon uses CMake, to build it run: +```sh +$ mkdir build && cd build +$ cmake .. +$ make && make install ``` -mkdir build && cd build -cmake .. -make + +## Dependencies +- 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_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 + +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`. + + +