From ab91d9d97a0cc66ac6306b0ed7bf1adec0616586 Mon Sep 17 00:00:00 2001 From: Good Guy Date: Fri, 20 Dec 2024 12:59:50 -0700 Subject: [PATCH] Clarification of adding context Help when creating an appimage --- parts/Developer.tex | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/parts/Developer.tex b/parts/Developer.tex index 0b10967..646334a 100644 --- a/parts/Developer.tex +++ b/parts/Developer.tex @@ -768,9 +768,11 @@ Then move to the \texttt{/\{path to cinelerra-5.1}/\} directory. There are two preliminaries to do before running the script: -1- If context sensitive help in the appimage version is required, the source of the manual and the tools (packages) to build it must be on the system. In the bld\_appimage.sh script, set the variable \texttt{MANUAL\_DIRECTORY=\$(pwd)/../../ cin-manual-latex} to the path of the source of the manual. If the variable is empty, or the specified directory does not exist, \CGG{} will be built without built-in help. The path to the manual source can be an absolute or relative one. +1- If context sensitive help in the appimage version is required, the source of the manual and the tools (packages) to build it must be on the system. In the bld\_appimage.sh script, set the variable \texttt{MANUAL\_DIRECTORY=\$(pwd)/../../ cin-manual-latex} to the path of the source of the manual. If the variable is empty, or the specified directory does not exist, \CGG{} will be built without built-in help. The path to the manual source can be an absolute or relative one. An easier method to include the help from the manual rather than having to install a bunch of latex building software, is to simply download the latest tgz version from {\small\url{https://cinelerra-gg.org/download/images/HTML_Manual-202xxxxx.tgz}}. +Then extract the files using "tar xvf" into the cinelerra AppDir/usr/bin/doc directory. +This alternative method may not contain the most recent changes to the Manual but rather will contain what had been checked into Git by the date of the tgz file. -2- The script bld\_appimage.sh uses a platform specific version of appimagetool so that it can create appimages for \textit{x86\_64}, \textit{i686}, \textit{aarch64}, or \textit{armv7l} architecture. We need to add appimagetool-(platform).AppImage to the \texttt{/\{path to cinelerra- 5.1\}/tools} directory, or somewhere in your path. You can download the tool for your system (e.g. appimagetool-x86\_64.AppImage) from git: {\small\url{https://github.com/AppImage/AppImageKit/releases}} +2- The script bld\_appimage.sh uses a platform specific version of appimagetool so that it can create appimages for \textit{x86\_64}, \textit{i686}, \textit{aarch64}, or \textit{armv7l} architecture. We need to add appimagetool-(platform).AppImage to the \texttt{/\{path to cinelerra- 5.1\}/tools} directory, or somewhere in your path. You can download the tool for your system (e.g. appimagetool-x86\_64.AppImage) from git: {\small\url{https://github.com/AppImage/AppImageKit/releases}}. Be aware of the possibility that an older appimagetool from 2020 might work better on some systems compared to the latest release. Always remember to make it executable. The four supported platforms are: -- 2.26.2