gered/mkb_generate
Archived
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

tweak README a bit

Browse source
This commit is contained in:
Gered 2013-01-06 13:20:40 -05:00
parent f3f4e98843
commit dae990198a
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,4 +1,4 @@
## Marmalade MKB Source File Listing Generator # Marmalade MKB Source File Listing Generator
This is a script which allows you to automatically populate a list This is a script which allows you to automatically populate a list
of source files/directories in your MKB files. The source files may of source files/directories in your MKB files. The source files may
@ -9,7 +9,7 @@ comes to wanting to specify source files which are organized
into many different directories and subdirectories. This script into many different directories and subdirectories. This script
helps work around this limitation. helps work around this limitation.
# Usage ## Usage
You first create a template file **mkb_template.txt** for your MKB. You first create a template file **mkb_template.txt** for your MKB.
This will contain all the normal things found in an MKB file like This will contain all the normal things found in an MKB file like
@ -44,7 +44,7 @@ replaces it. Every other line is copied to the output MKB file as-is.
**mkb_generate** will overwrite the existing MKB file if one is there. **mkb_generate** will overwrite the existing MKB file if one is there.
# Configuration ## Configuration
At the top of the **mkb_generate** script there are some config At the top of the **mkb_generate** script there are some config
variables that can and should be modified to your needs. variables that can and should be modified to your needs.
@ -55,7 +55,7 @@ variables that can and should be modified to your needs.
The rest of the config variables probably don't need to be modified. The rest of the config variables probably don't need to be modified.
# How PROJECT_NAME is Automatically Set ## How PROJECT_NAME is Automatically Set
This is largely based on my own personal conventions and may not This is largely based on my own personal conventions and may not
apply to everyone. If that is the case, you can just manually set apply to everyone. If that is the case, you can just manually set
@ -63,7 +63,8 @@ the value to whatever you need.
By default, the **mkb_generate** script will automatically set the By default, the **mkb_generate** script will automatically set the
**PROJECT_NAME** value based on an assumed directory structure **PROJECT_NAME** value based on an assumed directory structure
for your project, similar to the one shown below: for your project, similar to the one shown below which is how all
my projects are typically set up:
/some/directory/containing /some/directory/containing
/ProjectName /ProjectName