Document .AppImage creation and run

libreosteo · May 9, 2020 · a2e2625 · a2e2625
1 parent 19a3a43
commit a2e2625
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -110,3 +110,21 @@ export PATH=$PATH:$PWD
 ```
   robot tests
 ```
+
+Building an AppImage executable for GNU/Linux
+=========================================================
+
+Building an AppImage allows to provide and ship an easy-way to use LibreOsteo for
+linux users.
+
+To build a LibreOsteo `.AppImage`, setup development environment, and then
+issue :
+
+    $ bash pkg/appimage/mk_appimage.sh
+
+Then a `*.AppImage` standalone binary reflecting current working dir will be
+built. That resulting *.AppImage* could be then shipped on its own. To execute
+it on any Linux distro :
+
+    $ chmod +x LibreOsteo*.AppImage
+    $ ./LibreOsteo-VERSION.AppImage
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -5,7 +5,7 @@ Changelog for Libreosteo
 0.6.1 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Allow .AppImage Linux executable creation (#226)
 
 
 0.6.0 (2019-10-16)