updated make docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2022-03-22 00:11:34 +03:00
parent a94b9e4981
commit a9f5f76959
2 changed files with 26 additions and 4 deletions

View File

@ -191,9 +191,9 @@ NPX := npx --yes
# Warn user... # Warn user...
_ := $(if $(FIRST_RUN),\ _ := $(if $(FIRST_RUN), $(info \
$(info Missing ./node_modules/: Running make on a clean repository \ Missing ./node_modules/: Running make on a clean repository may take \
may take some time... )) some time... ))
# less... # less...

View File

@ -26,14 +26,24 @@ Variables to control the build:
APP_NAME - Application name APP_NAME - Application name
APP_BIN - App binary name (ignored for MacOS) APP_BIN - App binary name (ignored for MacOS)
ARCH - target achitecture (ia32, x86, x64, ...)
TARGET_OS - target OS (win32, linux, darwin) TARGET_OS - target OS (win32, linux, darwin)
ARCH - target achitecture (ia32, x86, x64, ...)
ELECTRON_DOWNOAD_URL ELECTRON_DOWNOAD_URL
- URL to download electron binary - URL to download electron binary
ELECTRON_DIST - electron distribution file name pattern ELECTRON_DIST - electron distribution file name pattern
BUILD_MODE - can be "repack" or "in-place" (default) BUILD_MODE - can be "repack" or "in-place" (default)
Variables to help with troubleshooting:
IMAGEGRID_DEBUG - force show devtools on startup
NOTE: devtools will should start automaticalky
if loading takes too long or if it was
started on last run,
IMAGEGRID_FORCE_SHOW
- force show viewer GUI on startup
NOTE: when setting variables avoid using spaces and other characters NOTE: when setting variables avoid using spaces and other characters
make can get fussy about... make can get fussy about...
NOTE: to do a repack build call: NOTE: to do a repack build call:
@ -69,6 +79,14 @@ Examples:
# build for darwin... (EXPERIMENTAL) # build for darwin... (EXPERIMENTAL)
$ TARGET_OS=darwin make clean dist $ TARGET_OS=darwin make clean dist
# run with Devtools started...
$ IMAGEGRID_DEBUG=1 make run
# force show the main window...
$ IMAGEGRID_FORCE_SHOW=1 make run
Help and info: Help and info:
help: Print make target help and exit help: Print make target help and exit
@ -113,5 +131,9 @@ Deb package:
CLI package: CLI package:
Patches:
patched-requirejs: Patch requirejs (see: NOTES)
unpatched-requirejs: Unpatch requirejs
--- ---
This file was generated by: make doc/MAKE This file was generated by: make doc/MAKE