Fix misc syntax-check problems
[entangle:entangle.git] / README
1        Entangle: Tethered Camera Control & Capture
2        ===========================================
3
4 Entangle is an application which uses GTK and libgphoto2 to provide a
5 graphical interface for tethered photography with digital cameras.
6
7 It includes control over camera shooting and configuration settings
8 and 'hands off' shooting directly from the controlling computer.
9
10 Installation
11 ------------
12
13 The libvirt-sandbox package uses GNU autotools, so the build install
14 process follows the standard process documented in the INSTALL file.
15 As a quick start you can do
16
17   ./configure --prefix=/usr --sysconfdir=/etc \
18         --localstatedir=/var --libdir=/usr/lib
19   make
20   sudo make install
21
22 Or to install into a private user specific location
23
24   ./configure --prefix=$HOME/libvirt-sandbox
25   make
26   make install
27
28 NB, if not installing in /usr, you need to set the XDG_DATA_DIRS env
29 variable to point to the data directory, eg in the above example use:
30
31   XDG_DATA_DIRS=/usr/share:/usr/local/share:$HOME/libvirt-sandbox/share
32   export XDG_DATA_DIRS
33
34 Building entangle requires the following external packages to
35 be present
36
37  glib2                 >= 2.26.0
38  gdk-pixbf             >= 2.12.0
39  gtk3                  >= 3.0.0
40  libgphoto2            >= 2.4.11
41  gudev                 >= 145
42  dbus-glib             >= 0.60
43  gobject-introspection >= 0.9.3
44  lcms                  >= 1.18
45  libpeas               >= 0.5.5
46  gexiv2                >= 0.2.2
47
48
49 Communication
50 -------------
51
52 To communicate with the development team, or to post patches
53 there is a technical mailing list:
54
55    https://mail.gna.org/listinfo/entangle-devel/
56
57 Bugs found when using an OS distribution's binary packages should
58 be reported to the OS vendors' own bug tracker first. Otherwise
59 they can be reported to
60
61    https://gna.org/bugs/?group=entangle
62
63 The latest libvirt-sandbox code can be found in GIT at:
64
65    https://gitorious.org/entangle/entangle
66
67 For further information visit
68
69    http://entangle-photo.org/
70
71
72 UI shortcuts
73 ------------
74
75 There are a number of shortcuts available for common operations
76
77  - 's' - Trigger the shutter, to shoot a picture
78  - 'p' - Toggle 'live view' preview mode
79  - 'esc' - Cancel the current operation
80  - 'm' - Toggle aspect ratio image mask
81
82 License
83 -------
84
85 Entangle is distributed under the terms of the GNU GPL v3+, except
86 for the Logo which is under the Creative Commons 1.0 Public
87 Domain Dedication.
88
89 Please see the COPYING file for the complete GPLv3+ license
90 terms, or visit <http://www.gnu.org/licenses/>.
91
92 -- End