Switch to new Stylesheet type
[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).  You will need
38 to install Meson, which is probably in your distribution package manager.
39 For example:
40 $ sudo dnf install meson
41 or
42 $ sudo apt install meson
43
44 You will also need the GTK 3 development files, which are also probably in your
45 distribution if they are not already installed:
46 $ sudo dnf install  gtk3-devel
47 or
48 $ sudo apt install libgtk-3-dev
49
50 If you're running OS X, please install Homebrew (https://brew.sh), and the all dependencies:
51 $ brew install gettext meson ninja gtk+3
52
53 Then set up the build directory using Meson:
54 $ meson builddir   # where "builddir" is your name for the build directory
55
56 Meson will (by default) create Ninja files which behave like makefiles.
57 Compile Colloquium using Ninja:
58 $ ninja -C builddir  # where "builddir" matches the previous step
59
60 To install:
61 $ sudo ninja -C builddir install
62
63 You can have multiple build directories, perhaps with different configurations.
64
65
66 Running the program
67 -------------------
68
69 Colloquium should appear in your desktop environment's menus.  Alternatively,
70 it can be started from the command line:
71 $ colloquium
72
73 The first time Colloquium runs, it will show an introduction document.
74
75
76 Contributing
77 ------------
78
79 Git repository:  git://git.bitwiz.me.uk/colloquium.git
80                  https://git.bitwiz.me.uk/?p=colloquium.git
81
82   Or on GitHub:  https://github.com/taw10/colloquium/
83
84  Issue tracker:  https://github.com/taw10/colloquium/issues