[gobject-introspection] website: add a page with build/test instructions



commit 765f61985950935214466b80c441abf2e25b9e9a
Author: Christoph Reiter <reiter christoph gmail com>
Date:   Fri Dec 14 12:05:15 2018 +0100

    website: add a page with build/test instructions
    
    My goal here is to keep it simple and get people started quickly.
    
    See !96

 docs/website/build_test.rst | 68 +++++++++++++++++++++++++++++++++++++++++++++
 docs/website/index.rst      |  1 +
 2 files changed, 69 insertions(+)
---
diff --git a/docs/website/build_test.rst b/docs/website/build_test.rst
new file mode 100644
index 00000000..3dc3bb69
--- /dev/null
+++ b/docs/website/build_test.rst
@@ -0,0 +1,68 @@
+Build & Test
+============
+
+Clone gobject-introspection with git:
+
+.. code:: shell
+
+    git clone https://gitlab.gnome.org/GNOME/gobject-introspection.git
+    cd gobject-introspection
+
+
+Autotools
+---------
+
+Build:
+    .. code:: shell
+
+        ./autogen.sh
+        # To see the build options run "./configure --help"
+        make
+
+Test:
+    .. code:: shell
+
+        make check  # run tests
+        make check.quality  # run code quality checks
+
+
+Meson
+-----
+
+Build:
+    .. code:: shell
+
+        meson _build
+        cd _build
+        # To see the build options run "meson configure"
+        ninja _build
+
+Test:
+    .. code:: shell
+
+        meson test  # run tests
+        flake8 ..  # run code quality checks
+
+
+Dependencies
+------------
+
+gobject-introspection depends on a row of other packages, either strictly,
+optionally or only for testing. The following installation instructions should
+over all cases for some common Distributions.
+
+Debian/Ubuntu:
+    .. code:: shell
+
+        sudo apt install pkg-config python3-dev flex bison libglib2.0-dev \
+            autoconf-archive libcairo2-dev libffi-dev python3-mako \
+            python3-markdown python3-distutils meson build-essential \
+            gtk-doc-tools
+
+Fedora:
+    .. code:: shell
+
+        sudo dnf install pkg-config flex bison cairo-devel
+            cairo-gobject-devel autoconf-archive python3-mako gcc automake \
+            autoconf python3-markdown meson libffi-devel python3-devel \
+            python3 gtk-doc 
diff --git a/docs/website/index.rst b/docs/website/index.rst
index fcbf9451..7ac74153 100644
--- a/docs/website/index.rst
+++ b/docs/website/index.rst
@@ -13,6 +13,7 @@ GObject Introspection
     goals
     architecture
     users
+    build_test
     writingbindableapis
     buildsystems/index
     annotations/index


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]