summaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 00000000..6199b9af
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,43 @@
+## Building rekonq from source
+
+
+### Prerequisites
+
+To build, rekonq needs at least:
+
+- Qt6 and Qt WebEngine
+- cmake 2.23
+- gcc 12
+
+### Optional dependencies
+
+The tests can be enable with ``-DTESTING=ON`` and require gtest.
+
+## Building rekonq
+
+Once you have cloned the repository you need to clone the submodules with:
+
+```sh
+git submodule update --init
+```
+
+To build it perform the following commands:
+
+```sh
+cmake -B build -DCMAKE_BUILD_TYPE=Release
+make -C build
+sudo make -C build install
+```
+
+If you want to install rekonq locally, do not run the ``make install`` command.
+rekonq can then be found in ``build/src`` and is executed with ``./rekonq``.
+
+## Getting Help
+
+
+## Useful Links
+
+repository: https://bitbucket.org/celestriad/rekonq
+
+Enjoy rekonq :D
+