Keep the progress/cancel toolbar permanently visible
[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 OS distro packagers should use the --disable-schemas-compile arg
35 to configure to skip the compilation stage for schema files if
36 installing to the /usr prefix
37
38 Building entangle requires the following external packages to
39 be present
40
41  glib2                 >= 2.26.0
42  gdk-pixbf             >= 2.12.0
43  gtk3                  >= 3.0.0
44  libgphoto2            >= 2.4.11
45  gudev                 >= 145
46  dbus-glib             >= 0.60
47  gobject-introspection >= 0.9.3
48  lcms                  >= 1.18
49  libpeas               >= 0.5.5
50  gexiv2                >= 0.2.2
51  LibRaw                >= 0.9.0
52
53
54 Communication
55 -------------
56
57 To communicate with the development team, or to post patches
58 there is a technical mailing list:
59
60    https://mail.gna.org/listinfo/entangle-devel/
61
62 Bugs found when using an OS distribution's binary packages should
63 be reported to the OS vendors' own bug tracker first. Otherwise
64 they can be reported to
65
66    https://gna.org/bugs/?group=entangle
67
68 The latest libvirt-sandbox code can be found in GIT at:
69
70    https://gitorious.org/entangle/entangle
71
72 For further information visit
73
74    http://entangle-photo.org/
75
76 Translators please see po/README.I18N for more guidance.
77
78 UI shortcuts
79 ------------
80
81 There are a number of shortcuts available for common operations
82
83  - 's' - Trigger the shutter, to shoot a picture
84  - 'p' - Toggle 'live view' preview mode
85  - 'esc' - Cancel the current operation
86  - 'm' - Toggle aspect ratio image mask
87  - 'h' - Toggle linear / logarithmic histogram
88  - 'a' - Drive autofocus during preview
89  - ',' or '.' - Drive manual focus during preview (fine control)
90  - '<' or '>' - Drive manual focus during preview (coarse control)
91
92 License
93 -------
94
95 Entangle is distributed under the terms of the GNU GPL v3+, except
96 for the Logo which is under the Creative Commons 1.0 Public
97 Domain Dedication.
98
99 Please see the COPYING file for the complete GPLv3+ license
100 terms, or visit <http://www.gnu.org/licenses/>.
101
102 -- End