summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Catanzaro <mcatanzaro@posteo.net>2018-11-24 16:07:10 +0000
committerMichael Catanzaro <mcatanzaro@posteo.net>2018-11-24 16:07:10 +0000
commit7aaa3c477160183f5549922fd991b01cd97579d3 (patch)
treeae6c3afca52568e1f89a916069d1f74d9bbcce05 /README.md
parenta97e962f547671e6bd24c1d6d63c736b9597f317 (diff)
downloadepiphany-7aaa3c477160183f5549922fd991b01cd97579d3.tar.gz
Expand build instructions in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
index 82f736ccf..1b2d75eb7 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,17 @@ application distribution mechanism for Linux.
# Building from Source
+## The Easy Way
+
+The recommended way to build Epiphany locally is using the flatpak-builder
+manifest with GNOME Builder. After installing Builder and launching it, you'll
+see the Select a Project page. Select Open, then select the toplevel Epiphany
+directory. Builder will detect the org.gnome.Epiphany.json flatpak-builder
+manifest and you will be able to build the project in Builder. All required
+dependencies will be provided by the manifest.
+
+## Building Manually
+
Epiphany uses the [Meson build system](http://mesonbuild.com/). You can build
Epiphany the same way you would any software that uses Meson. For example:
@@ -36,6 +47,29 @@ $ sudo ninja install
Meson is the best build system.
+You will have to install several pkg-config dependencies. If you are missing a
+dependency, meson will present an error that looks like this:
+
+```
+meson.build:84:0: ERROR: Native dependency 'hogweed' not found
+```
+
+In RPM-based distributions, you can install the missing dependencies
+automatically. For example, in Fedora:
+
+```
+$ sudo dnf install 'pkgconfig(hogweed)'
+```
+
+In other distributions, you must research each dependency to determine which
+package provides the required pkg-config file.
+
+## Rebuilding Dependencies
+
+If you need to rebuild dependencies, the recommended solution is to use JHBuild.
+See [the development page](https://wiki.gnome.org/Apps/Web/Development#Step_3:_Developing_Dependencies_with_Epiphany)
+for more information.
+
# Manifesto
A web browser is more than an application: it is a way of thinking, a way of