====== KempoMake : Quick Start Guide ======

===== Check Configuration =====

Here is a simple test to see if KempoMake is properly configured:

  - Create a projects directory. (ie /proj/)
  - Unarchive the KempoMake archive into this directory.
  - Open /proj/KempoMake/default.mk with a text editor and edit the PROJROOT variable for your setup. Modify other defaults as you wish.
  - Open a shell up.
  - Change to the KempoMake directory: <code>cd /proj/KempoMake/Project/</code>
  - Create a sample library: <code>make -r -R CreateLibrary NAME=SampleLib PLATFORM=Win32</code>
  - Open a second shell up.
  - Change to the KempoMake directory: <code>cd /proj/KempoMake/Project/</code>
  - Create a sample application: <code>make -r -R CreateApplication NAME=SampleApp PLATFORM=Win32</code>


===== Sample Library/Application =====

Now in your first shell:
<code>cd /proj/SampleLib/Project
make -r -R PLATFORM=Win32</code>

Once the first shell is done building, in your second shell:
<code>cd /proj/SampleApp/Project
make -r -R PLATFORM=Win32</code>

===== The "BUILD" variable =====

A note, there is a "BUILD" variable, which can be either "DEBUG", "PARTIAL", or "FINAL".


==== Build Levels Explained ====

There are three "build levels", as follows:

  * DEBUG - Generates debug symbols,    has all assertion/exception handling code, no optimizations whatsoever
  * PARTIAL - Generates no debug symbols, has all assertion/exception handling code, all optimizations on
  * FINAL - Generates no debug symbols, has no assertion/exception handling code,  all optimizations on

The idea with the build levels is simply this:
  * DEBUG - Internal builds, run by the programmers to find errors
  * PARTIAL - Internal/External builds, run by beta testers to find bugs
  * FINAL - External builds, this is release code, and should therefore have zero chance to assert

The default build level is "DEBUG".

Open a third shell, and type:
<code>z:\proj\SampleApp\Project\Win32\DEBUG\SampleApp.exe</code>

You should then see this:
<code>printFoward: First Statement
printBackwards: tnemetatS dnoceS
printLeet: ThIrD StAtEmEnT</code>

...Which means that the Sample Library and Sample Application are both working. Congratulations.


===== Platform support =====

<note warning>Currently only the **Win32 platform** is supported at this time.</note>

You may add support for additional platforms similarly.

To add platform support for a library, for instance Linux:
<code>cd /proj/KempoMake/
make -r -R AddLibraryPlatform NAME=SampleLib PLATFORM=Linux</code>

To add platform support for an application, for instance on Linux:
<code>cd /proj/KempoMake/
make -r -R AddApplicationPlatform NAME=SampleApp PLATFORM=Linux</code>

To start your own project, change the NAME variable in the make command line.