Explaining how to populate local-config.mk file properly from global-config.mk - Close #6

This commit is contained in:
yannk 2021-12-20 22:53:04 +01:00
parent eb12212546
commit 8ddd3d1cce

View file

@ -6,7 +6,7 @@ This repository use [Git LFS](https://git-lfs.github.com/).
### Configuration of the Makefile
The file `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 and concerns only example files included with the script. Moreover is handled by git for new versions and any changes you make would be erased by new pull of the script. To specify dedicated values 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. You will have to do it at least to take in charge your persnal data and not the `example` content given.
The file `global-config.mk` contains configuration informations about paths to sources, executables and to the building destinations. It details all the variables which can be set. Be aware that it shouldnt be modified, as it can receive new variables in the future needed for the script to work and concerns only example files included with the script. Moreover it is handled by git for new versions and any changes you make would be erased by new pull of the script. To specify dedicated values to any variable, you should copy its line definition to a new file in 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. You will have to do it at least to take in charge your personal data and not the `example` content given.
Simply write either the absolute or the relative path from your Makefile script situation for any information needed.