YannK/Textures_factory
YannK/Textures_factory
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Packages Wiki Activity Actions

Adding informations about config files

Browse source
This commit is contained in:
yannk 2021-12-17 22:52:29 +01:00
parent 37f4c78f3b
commit 1035416935
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -6,11 +6,9 @@ This repository use [Git LFS](https://git-lfs.github.com/).
### Configuration of the Makefile ### Configuration of the Makefile
The beginning of the Makefile contains all the variables and configuration needed. 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 shouldn’t be modified, as it can receive new variables in the future needed for the script to work, and is handled by git for new versions. 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.
# Variables definitions Simply write either the absolute or the relative path from your Makefile script situation for any information needed.
The very first one shouldn’t be changed, as it will check the proper shell is used to execute the script.
## Executables used ## Executables used
@ -18,13 +16,13 @@ These are the adress of the substance automation toolkit binaries.
## Sbsar files generation part ## Sbsar files generation part
You need to define a sbs source folder where the script will check for new content. It must be indicated in the corresponding place there. Simply write either the absolute or the relative path from your Makefile script situation for the `SBS_DIR` variables content. You need to define a sbs source folder where the script will check for new content in the `SBS_DIR` variables content.
You must write down also the place where the script will write the generated sbsar. You must write down also the place where the script will write the generated sbsar.
## Texturesets files ## Texturesets files
You can leave the folder indicated here, as it will be used only internally by the script to check the texturesets it handles. This files will be used only internally by the script to check the texturesets it handles.
# Texture names possible # Texture names possible