falkonOfficial/README.md

# Falkon

Falkon is a KDE web browser. It uses QtWebEngine rendering engine.

![image](https://www.falkon.org/images/screenshot.png)

## Downloads

Falkon downloads are available from [homepage](https://www.falkon.org/download/).

## Building

```sh
mkdir build && cd build
cmake ..
make && make install
```

### Install to custom prefix

When installing Falkon to custom prefix, you may need to adjust `XDG_DATA_DIRS` environment variable.

```sh
# Build
cmake -DCMAKE_INSTALL_PREFIX=$HOME/falkon

# Run
export XDG_DATA_DIRS="$HOME/falkon/share:$XDG_DATA_DIRS"
$HOME/falkon/bin/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 `irc.libera.chat`.
-												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

											
										
										
											2019-03-19 17:28:49 +01:00
+								# Falkon
-												README: Add basic build instructions

											
										
										
											2018-03-27 10:39:10 +02:00
-												README: Minor edits and add info about custom prefix install

											
										
										
											2019-03-19 17:49:25 +01:00
+								Falkon is a KDE web browser. It uses QtWebEngine rendering engine.
-												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

											
										
										
											2019-03-19 17:28:49 +01:00
+								![image](https://www.falkon.org/images/screenshot.png)
-												README: Add basic build instructions

											
										
										
											2018-03-27 10:39:10 +02: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

											
										
										
											2019-03-19 17:28:49 +01:00
+								## Downloads
-												README: Add basic build instructions

											
										
										
											2018-03-27 10:39:10 +02:00
-												README: Minor edits and add info about custom prefix install

											
										
										
											2019-03-19 17:49:25 +01:00
+								Falkon downloads are available from [homepage](https://www.falkon.org/download/).
-												README: Add basic build instructions

											
										
										
											2018-03-27 10:39:10 +02: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

											
										
										
											2019-03-19 17:28:49 +01:00
+								## Building
 								```sh
-												README: Minor edits and add info about custom prefix install

											
										
										
											2019-03-19 17:49:25 +01:00
+								mkdir build && cd build
 								cmake ..
 								make && make install
 								```
 								### Install to custom prefix
 								When installing Falkon to custom prefix, you may need to adjust `XDG_DATA_DIRS` environment variable.
 								```sh
 								# Build
 								cmake -DCMAKE_INSTALL_PREFIX=$HOME/falkon
 								# Run
 								export XDG_DATA_DIRS="$HOME/falkon/share:$XDG_DATA_DIRS"
 								$HOME/falkon/bin/falkon
-												README: Add basic build instructions

											
										
										
											2018-03-27 10:39:10 +02: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

											
										
										
											2019-03-19 17:28:49 +01:00
 								## 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
-												Update IRC network in the README

KDE has moved from freenode to Libera Chat, update the README to reflect
this.

											
										
										
											2021-05-24 06:06:49 +02:00
+								You can get in contact with developers using [mailing list](https://mail.kde.org/mailman/listinfo/falkon) or __IRC__ `#falkon` at `irc.libera.chat`.