/****************************************************
* Carnap Project Readme
* Prepared by Cameron McInally (xkrebstarx@gmail.com)
* Last Update 5/25/07
****************************************************/



Contents
********

	1) The Repository
	2) Configuring the Project




1) The Repository
*****************

The Carnap SVN repository can be found at 

	http://repository.carnap.info/

If you are familiar with CVS, then SVN should be no trouble. You can find the 
latest build and information on Subversion at:

	http://subversion.tigris.org/


From the command line:
======================

To check out the project, type:

	% svn co http://repository.carnap.info

This will retrieve the latest revision from the Carnap servers.

To check in the project, type:
	
	% svn commit –m “<Your Comment Here>”

This will update the lastest revision. Please note that only Carnap Administrators 
can commit a project. If you would like to submit a patch, please email your fix 
to patch@carnap.info, with "[PATCH] <Title>" as the Subject and a short desciption in 
the Body of your email.

Subversion Client for Windows:
==============================

   http://tortoisesvn.tigris.org/

Subversion Client for Mac OS X:
===============================

   http://scplugin.tigris.org/




2) Configuring the Project
**************************

First, pull down the root of the SVN,
http://coparoom.com/carnap/svn/, onto your local machine. In the
directory /svn/trunk, you will see two projects "grammar" and
"compiler".


Building the Grammar
====================

/grammar/carnap.g is the current grammar that is in use. Load this up in ANTLRWorks. http://www.antlr.org/works/.

(NOTE: I have had some problems with different versions of
ANTLRWorks. If it gives you any problems, I would immediately assume
it is ANTLRWorks and ignore it for the time being. The compiler
project has working copies of the Lexer and Parser.)

In ANTLRWorks, there's an option in

File -> Preferences

to point the generated source code to a specific directory. The
working directory for the output is
/compiler/Carnap_Project/src/info/carnap/tools/parser/.

Thats it for the grammar. Now when you generate any code, it will
automatically update the compiler project.



Building the Compiler
=====================

For the Carnap Compiler project, I use Eclipse. I will create a new
project in Eclipse and select the "Create project from an existing
source" option.

/compiler/Carnap_Project/ is the root directory for this project.

This should load up the project correctly. If it doesn't, send the
error messages over and I will help you work it out. (xkrebstarx@gmail.com)