CalcRogue Documentation

Setup and Compiling

What you need

Before you compile CalcRogue, if you are a Windows user, you will need:

Cygwin (including make, m4, gcc, g++, cpp, lex, and yacc.) http://www.cygwin.com/
TIGCC (the very latest version - old versions usually don't work) http://tigcc.ticalc.org/
The TIGCC Tools Suite
Doxygen (optional, but can be used to make this documentation) http://www.doxygen.org/

Linux users, obviously, don't need Cygwin, but they do need working versions of the tools mentioned.

Configuring

Take a look at Makefile.config and make sure all of the 'tool paths' listed are correct. Then look at Makefile.comp, and select the correct compiler (MSVC, GCC, or MinGW).

Building

Now, just type 'make', and (hopefully) everything will build correctly.

You can browse CalcRogue's source with any text editor, but it will be much more readable if you have yours set up correctly. Set your tab size to four so that things will line up. Also, if your editor supports it, enable folding; you should have it set so that {{{ and }}} are fold markers and the first non-comment line inside a fold is shown.

Licensing

This program 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 2 of the License, or (at your option) any later version.

This program 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.

The full text of the GNU General Public License may be found in the file COPYING. You should have received this file along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

Generated on Thu May 20 13:12:08 2004 for CalcRogue by