Instructions how to define local configuration variables for the script

This commit is contained in:
yannk 2021-12-17 23:11:53 +01:00
parent 3ab1a821a3
commit e1bb559daa

View file

@ -6,7 +6,7 @@ This repository use [Git LFS](https://git-lfs.github.com/).
### Configuration of the Makefile ### Configuration of the Makefile
The files `global-config.mk` and `local-config.mk` contain configuration informations about paths to sources, executables and to the building destinations. The `global-config.mk` one contains all the variables which can be set and shouldnt be modified, as it can receive new variables in the future needed for the script to work. Moreover is handled by git for new versions and any changes you make would be erased by new pull of the script. If you want to specify a dedicated value to any variable, you should copy its line definition to the `local-config.mk` file, as it has been done for the preview build folder as example. Like this, you will keep your local configuration files in the future with new versions of the script. The files `global-config.mk` contain configuration informations about paths to sources, executables and to the building destinations. It details all the variables which can be set but shouldnt be modified, as it can receive new variables in the future needed for the script to work. Moreover is handled by git for new versions and any changes you make would be erased by new pull of the script. If you want to specify a dedicated value to any variable, you should copy its line definition to a new file inf the same folder, called `local-config.mk`. Like this, you will keep your local configuration files in the future with new versions of the script.
Simply write either the absolute or the relative path from your Makefile script situation for any information needed. Simply write either the absolute or the relative path from your Makefile script situation for any information needed.