Update README
[colloquium.git] / README
1 --------------------------------------------------------------------------------
2
3 Colloquium: Narrative-based presentation system
4
5 Copyright © 2017-2018 Thomas White
6
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20 Author: Thomas White <taw@bitwiz.org.uk>
21 See the COPYING file for full licence conditions.
22
23 --------------------------------------------------------------------------------
24
25 Summary
26 -------
27
28 Colloquium is a presentation program that is more than just "slideware".
29 Instead of concentrating on slides, Colloquium makes the "narrative" of your
30 presentation the most important thing.  Slides are embedded in your narrative,
31 forming part of the flow of your talk.
32
33
34 Installation instructions
35 -------------------------
36
37 Colloquium uses the Meson build system (http://mesonbuild.com), which works
38 with Ninja (https://ninja-build.org/).  Start by installing these if you don't
39 already have them.  For example, in Fedora:
40    $ sudo dnf install meson ninja-build
41 or for Debian/Ubuntu:
42    $ sudo apt install meson ninja-build
43 or for Mac OS users, using Homebrew (https://brew.sh):
44    $ brew install meson ninja
45
46 You will also need the gettext, GTK 3 and JSON-GLib development files:
47    $ sudo dnf install gettext-devel gtk3-devel json-glib-devel
48 or:
49    $ sudo apt install gettext-devel libgtk-3-dev libjson-glib-dev
50 or:
51    $ brew install gettext gtk+3 json-glib
52
53 Set up the build directory using Meson:
54    $ meson build
55
56 Compile Colloquium using Ninja:
57    $ ninja -C build
58
59 To install:
60    $ sudo ninja -C build install
61
62
63 Running the program
64 -------------------
65
66 Colloquium should appear in your desktop environment's menus.  Alternatively,
67 it can be started from the command line:
68    $ colloquium
69
70 The first time Colloquium runs, it will show an introduction document.
71
72
73 Contributing
74 ------------
75
76 Git repository:  git://git.bitwiz.me.uk/colloquium.git
77                  https://git.bitwiz.me.uk/?p=colloquium.git
78
79   Or on GitHub:  https://github.com/taw10/colloquium/
80
81  Issue tracker:  https://github.com/taw10/colloquium/issues