Remove old debian changelog and fix its creation.
[dcpomatic.git] / DEVELOP.md
index 78231b89e72a5b9fd91688477baab88a2906e498..e36c5260ebbe28a08bb13b56bc3e6f372d30adca 100644 (file)
@@ -4,12 +4,42 @@ This file collects a few notes relevant to DCP-o-matic developers.  There is als
 [on the web site](https://dcpomatic.com/development).
 
 
+## Building on macOS/arm64
+
+Build `osx-environment` in `$HOME`
+```
+bash platform/osx/copy_resources.sh
+source platform/osx/set_paths.sh
+./waf configure --target-macos-arm64
+```
+
+
+## Disk writer logging
+
+As we have no `film' folder to log to during disk writes, the logs end up:
+
+### macOS
+
+* Disk writer backend: `/var/log/dcpomatic_disk_writer_{out,err}.log`
+* Disk writer frontend: `/Users/$USER/Library/Preferences/com.dcpomatic/2/2.16/disk.log`
+
+### Windows
+
+* Disk writer backend: `c:\Users\$USER\AppData\Local\dcpomatic\2.16.0\disk_writer.log`
+* Disk writer frontend: `c:\Users\$USER\AppData\Local\dcpomatic\2.16.0\disk.log`
+
+### Linux
+
+* Disk writer backend: `/home/$USER/.config/dcpomatic/2.16.0/disk_writer.log`
+* Disk writer frontend: `/home/$USER/.config/dcpomatic/2.16.0/disk.log`
+
+
 ## 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`
+* `v2.17.x` - development branch for v2.17.x versions; `main` is merged into this branch.
 
 The `test/data` submodule has the following branches:
 
@@ -71,7 +101,7 @@ to load a script file called `stress` and start executing it.
 - ./waf pot
 - cp build/src/lib/libdcpomatic.pot src/lib/po/$LANG.po
 - cp build/src/wx/libdcpomatic-wx.pot src/wx/po/$LANG.po
-- cp build/src/tools/libdcpomatic-wx.pot src/tools/po/$LANG.po
+- cp build/src/tools/dcpomatic.pot src/tools/po/$LANG.po
 - sed -i "s/CHARSET/UTF-8/" src/{lib,wx,tools}/po/$LANG.po
 - Commit / push
 - Add credit to `src/wx/about_dialog.cc` and database.
@@ -88,3 +118,15 @@ The manual PDF looks nice if vector screenshots are used.  These can be taken as
 - 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` 
+
+
+## Adding a new variant
+
+Files to edit:
+- `cscript`
+- `wscript`
+- `src/lib/variant.cc`
+- `platform/osx/make_dmg.sh`
+- `platform/windows/wscript`
+- `platform/osx/wscript`
+