Pale source code: Build 105
-----------------

To compile the source code, you will need:

* A recent version of GCC for RISC OS, e.g. 3.4.6 release 3.
* The set of GNU utilities available with GCC (make, touch, sed, etc.)
* My WOUM library (available from http://www.quote-egnufeb-quote-greaterthan-colon-hash-comma-underscore-at.info/riscos/woum.php)

Simply place this source directory inside !Pale, and then after making sure the filer has seen !WOUM run the mkit obey file to build the program.


Source files - general
----------------------

makefile

The makefile.

mkit

  A handy obeyfile for building the !WOUM libraries, the makefile, the program executable, converting the HTML help file to text, and putting the right build number & date in the !Boot and Help files. Can also be run with 'mkit run' to trigger Pale to run if the build is successful.

Depp

  A handy BASIC program to maintain the dependencies in the makefile.

UpdateVer

  A BASIC program to update the build number and date. Also writes a short sed script that is used to update the build number & date in the !Boot and Help files.

appscript

  The sed script generated by Depp. This is not normally present, as mkit will delete it after it's been used.

html2text

  The sed script that converts the HTML help file to the text help file. Phear it!

appfiles.!Boot, appfiles.index/html

  The !Boot and HTML help files. These have ::VERSION:: and ::DATE:: markers in them, which, as part of the build process, will be copied into the !Pale folder and have the current build number and date filled.


Source files - program
----------------------

editor.c/.h	Code for the palette editor windows
loadsave.c/.h	Code for loading and saving sprite/palette files
pale.c/.h	Main code for WIMP event handling
preview.c/.h	Code for the sprite preview windows
sprfile.c/.h	Code for the main spritefile windows; also contains functions
		for remapping sprite/palette entries.
version.c/.h	Auto-updated version (build) number


Depp
----

At this point in time, Depp is rather simplistic. Once it is improved it will likely be included in the main WOUM distribution or as a standalone product.

Depp will recursively scan from the current directory, looking for all C, H and assembler files (S). It will then look for the #include directives (or GET for assembler) and add them to the end of the makefile. Supported syntax of the #include and GET directives is minimal at the moment, so when editing the source make sure you stick to the same formatting. If the first line of a file contains 'DEPPEND', Depp will skip the file (in particular it won't generate an .o dependency line in the makefile). DEPPEND can also be used to stop the processing of a file once all the #include directives have been passed. If a #include or GET line ends with 'NODEPP', that line will be ignored. This is currently used for skipping the kernel.h and swis.h includes, as Depp otherwise assumes they are source files in the current project.

Depp will perform some UNIX filename translation, and translate WOUM include paths to the format used in the Pale makefile.


Legal mumbo jumbo
-----------------

Pale is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Pale is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this source code.  If not, see <http://www.gnu.org/licenses/>.


Jeffrey Lee, 29/2/08
me@phlamethrower.co.uk
http://www.quote-egnufeb-quote-greaterthan-colon-hash-comma-underscore-at.info/
