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