summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan-Michael Brummer <jan.brummer@tabos.org>2023-03-17 11:06:28 -0400
committerJan-Michael Brummer <jan.brummer@tabos.org>2023-03-27 16:31:58 +0200
commitf71f6f4d6998ebfd30db4a78cc2843a735d5c059 (patch)
treeaf40218d465eef82eef268ca12024e2d1d36072e
parent5114d4714254d47c7ab32559c4a480e101609a5d (diff)
downloadlibproxy-git-f71f6f4d6998ebfd30db4a78cc2843a735d5c059.tar.gz
Add build step tutorial (#91)
Co-authored-by: Jan-Michael Brummer <jan-michael.brummer1@volkswagen.de>
-rw-r--r--docs/build-steps.md84
-rw-r--r--docs/meson.build1
-rw-r--r--docs/px.toml.in1
3 files changed, 86 insertions, 0 deletions
diff --git a/docs/build-steps.md b/docs/build-steps.md
new file mode 100644
index 0000000..fa3f187
--- /dev/null
+++ b/docs/build-steps.md
@@ -0,0 +1,84 @@
+Title: How to compile libproxy
+Slug: building
+
+# How to compile libproxy
+
+## Fedora
+
+### Dependencies
+
+```
+sudo dnf install glib2-devel duktape-devel libsoup3-devel meson gcovr gi-docgen libpeas-devel libcurl-devel vala gsettings-desktop-schemas-devel gobject-introspection-devel
+```
+
+### Build Setup
+
+```
+meson setup build
+```
+
+### Compilation
+
+```
+ninja -C build
+```
+
+### Installation
+
+```
+ninja -C build install
+```
+
+## OS X
+
+### Dependencies
+
+```
+pip install meson ninja
+brew install libsoup icu4c gobject-introspection duktape gcovr gi-docgen libpeas curl vala
+```
+
+### Build Setup
+
+```
+meson setup build
+```
+
+### Compilation
+
+```
+ninja -C build
+```
+
+### Installation
+
+```
+ninja -C build install
+```
+
+## Windows (MSYS2)
+
+### Dependencies
+
+```
+pacman -S base-devel git mingw-w64-x86_64-toolchain mingw-w64-x86_64-ccache mingw-w64-x86_64-pkg-config mingw-w64-x86_64-gobject-introspection mingw-w64-x86_64-python-gobject mingw-w64-x86_64-meson mingw-w64-x86_64-glib mingw-w64-x86_64-duktape mingw-w64-x86_64-gi-docgen mingw-w64-x86_64-libsoup3 mingw-w64-x86_64-libpeas mingw-w64-x86_64-curl mingw-w64-x86_64-vala
+```
+
+### Build Setup
+
+```
+meson setup build
+```
+
+### Compilation
+
+```
+ninja -C build
+```
+
+### Installation
+
+```
+ninja -C build install
+```
+
diff --git a/docs/meson.build b/docs/meson.build
index 3aac92a..cc5d1ad 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -2,6 +2,7 @@ if get_option('docs')
expand_content_md_files = [
'architecture.md',
+ 'build-steps.md',
'configuration-logic.md',
'perl.md',
'python.md',
diff --git a/docs/px.toml.in b/docs/px.toml.in
index 79ed69b..b70f23b 100644
--- a/docs/px.toml.in
+++ b/docs/px.toml.in
@@ -62,6 +62,7 @@ file_format = "{filename}#L{line}"
[extra]
content_files = [
"architecture.md",
+ "build-steps.md",
"configuration-logic.md",
"perl.md",
"python.md",