Replace HACKING document by CHECKLIST
authorColin Clark <colin.clark@cclark.uk>
Tue, 22 Jun 2021 15:24:21 +0000 (16:24 +0100)
committerColin Clark <colin.clark@cclark.uk>
Tue, 22 Jun 2021 15:24:21 +0000 (16:24 +0100)
Remove HACKING and replace by CHECKLIST.md

CHECKLIST.md [new file with mode: 0644]
HACKING [deleted file]

diff --git a/CHECKLIST.md b/CHECKLIST.md
new file mode 100644 (file)
index 0000000..a02f11e
--- /dev/null
@@ -0,0 +1,31 @@
+## A checklist to be used after Geeqie has been updated
+
+Before compiling the sources, carry out the following actions when necessary:
+
+* Update ```org.geeqie.Geeqie.appdata.xml.in``` with the latest released version and date
+* If source files have been added or removed from ```.src/``` directory, resync ```./po/POTFILES.in```   
+```
+cd ./po  
+./regen_potfiles.sh | patch -p0  
+```
+* Keep translations in sync with the code  
+```
+cd ./po  
+make update-po  
+```  
+* Update the the timezone database  
+```
+./scripts/zonedetect/create_timezone_database
+```
+
+After compiling the sources, carry out the following actions when necessary:  
+
+* Generate a new AppImage (note that this should be run on a **20.04 system**)  
+```
+./scripts/generate-appimage.sh <location of GeeqieWeb/appimages folder>
+```
+* Copy Help html files to ```<location of GeeqieWeb/help folder>```
+* Copy ```geeqie.desktop``` to ```<location of GeeqieWeb/ folder>```  
+* Copy ```org.geeqie.Geeqie.appdata.xml``` to ```<location of GeeqieWeb/ folder>```  
+* Upload to GeeqieWeb  
+
diff --git a/HACKING b/HACKING
deleted file mode 100644 (file)
index d7e27b7..0000000
--- a/HACKING
+++ /dev/null
@@ -1,21 +0,0 @@
-A brief overview for those that wish to work with the source.
-
-The Makefiles and configure script are generated by the autogen.sh script,
-usually only distributed with snapshot releases. Running autogen.sh requires
-automake and autoconf. GNU gettext may also be needed by autogen.sh.
-
-Git commits _require_ an explicit log message. Think it will be used in the
-release Changelog.
-
-Coders should respect general coding style (see CODING).
-
-Coders, please resync po/POTFILES.in if you add or remove source files from src/
-directory (using regen_potfiles.sh script in po/) and re-run make update-po when
-appropriate to keep translations in sync with the code.
-
-Maintainers, don't forget to run make update-po before releases.
-
-The scripts folder contains a script for generating the timezone database.
-The database will need updating occasionally.
-
-Translators, please have a look at po/README.