diff options
| author | Thomas White <taw@bitwiz.me.uk> | 2018-10-29 17:30:37 +0100 |
|---|---|---|
| committer | Thomas White <taw@bitwiz.me.uk> | 2018-10-29 17:30:37 +0100 |
| commit | 448f7261f3f90056e7a4cc33b59d147c71744a7e (patch) | |
| tree | 07c212bf5d053c08ec5ccb43180a71de3779feab | |
| parent | 36e9ae723b3caebaa7e58f58438913b174d57573 (diff) | |
Update README
| -rw-r--r-- | README | 47 |
1 files changed, 22 insertions, 25 deletions
@@ -34,33 +34,30 @@ forming part of the flow of your talk. Installation instructions ------------------------- -Colloquium uses the Meson build system (http://mesonbuild.com). You will need -to install Meson, which is probably in your distribution package manager. -For example: -$ sudo dnf install meson -or -$ sudo apt install meson - -You will also need the GTK 3 development files, which are also probably in your -distribution if they are not already installed: -$ sudo dnf install gtk3-devel -or -$ sudo apt install libgtk-3-dev - -If you're running OS X, please install Homebrew (https://brew.sh), and the all dependencies: -$ brew install gettext meson ninja gtk+3 - -Then set up the build directory using Meson: -$ meson builddir # where "builddir" is your name for the build directory - -Meson will (by default) create Ninja files which behave like makefiles. +Colloquium uses the Meson build system (http://mesonbuild.com), which works +with Ninja (https://ninja-build.org/). Start by installing these if you don't +already have them. For example, in Fedora: + $ sudo dnf install meson ninja-build +or for Debian/Ubuntu: + $ sudo apt install meson ninja-build +or for Mac OS users, using Homebrew (https://brew.sh): + $ brew install meson ninja + +You will also need the gettext, GTK 3 and JSON-GLib development files: + $ sudo dnf install gettext-devel gtk3-devel json-glib-devel +or: + $ sudo apt install gettext-devel libgtk-3-dev libjson-glib-dev +or: + $ brew install gettext gtk+3 json-glib + +Set up the build directory using Meson: + $ meson build + Compile Colloquium using Ninja: -$ ninja -C builddir # where "builddir" matches the previous step + $ ninja -C build To install: -$ sudo ninja -C builddir install - -You can have multiple build directories, perhaps with different configurations. + $ sudo ninja -C build install Running the program @@ -68,7 +65,7 @@ Running the program Colloquium should appear in your desktop environment's menus. Alternatively, it can be started from the command line: -$ colloquium + $ colloquium The first time Colloquium runs, it will show an introduction document. |