Double-click to edit cinemas/screens.

[dcpomatic.git] / DEVELOP.md

diff --git a/DEVELOP.md b/DEVELOP.md
index 01da64ec71871328b2fcc8fcf05cbe070574bf98..78231b89e72a5b9fd91688477baab88a2906e498 100644 (file)
--- a/DEVELOP.md
+++ b/DEVELOP.md
@@ -4,6 +4,19 @@ This file collects a few notes relevant to DCP-o-matic developers.  There is als
 [on the web site](https://dcpomatic.com/development).
 
 
+## Branches
+
+The main dcpomatic repo has the following branches:
+
+* `main` - the main development branch; contains 2.16.x versions
+* `v2.17.x` - development branch for v2.17.x versions; periodically rebased onto `main`
+
+The `test/data` submodule has the following branches:
+
+* `v2.16.x` - branch for use with v2.16.x versions
+* `v2.18.x` - branch for use with v2.17.x versions (as will become v2.18.x)
+
+
 ## Player stress testing
 
 If you configure DCP-o-matic with `--enable-player-stress-test` you can make a script which
@@ -64,3 +77,14 @@ to load a script file called `stress` and start executing it.
 - Add credit to `src/wx/about_dialog.cc` and database.
 - Add to `i18n.php` on website and `update-i18n-stats` script, then run `update-i18n-stats` script.
 
+
+## Taking screenshots for the manual
+
+The manual PDF looks nice if vector screenshots are used.  These can be taken as follows:
+
+- Build `gtk-vector-screenshot.git` (using meson/ninja)
+- Copy `libgtk-vector-screenshot.so` to `/usr/local/lib/gtk-3.0/modules/`
+- Run DCP-o-matic using `run/dcpomatic --screenshot`
+- Start `take-vector-screenshot`, click "Take screenshot" then click on the DCP-o-matic window.
+- Find a PDF in `/tmp/dcpomatic2.pdf`
+- Copy this to `doc/manual/raw-screenshots`