1
mirror of https://invent.kde.org/network/falkon.git synced 2024-11-11 01:22:10 +01:00

Updated README.md with detailed build instructions

Falkon introduction , building & contribution description added.
It will help new comers to build & contribute to the falkon easily.

Differential Revision: https://phabricator.kde.org/D19804
This commit is contained in:
Saish Mhatre 2019-03-19 17:28:49 +01:00 committed by David Rosca
parent 9601e8ad34
commit 426225efcc
No known key found for this signature in database
GPG Key ID: EBC3FC294452C6D8

View File

@ -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)
## Downloads
To download Falkon [click here](https://www.falkon.org/download/).
## Building
Falkon uses CMake, to build it run:
```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 isnt 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`.