SableCC version 3-beta.3

Welcome to SableCC version 3-beta.3.

Please read this document carefully.

• Getting Started
• License
• Documentation
• Getting Help
• Mailing-list
• Donations

Here are the minimal steps to get SableCC running.

If you got sablecc-3-beta.3.tar.gz (or sablecc-3-beta.3.zip)

1. Decompress the file sablecc-3-beta.3.tar.gz (or sablecc-3-beta.3.zip):

   	  tar -xzvf sablecc-3-beta.3.tar.gz
   	  

   or

   	  jar -xvf sablecc-3-beta.3.zip
         

2. Go into the in sablecc-3-beta.3 directory:

   	  cd sablecc-3-beta.3
         

3. You will find an executable sablecc.jar file in the lib directory:

   	  java -jar lib/sablecc.jar
         

This is it. If you have Jakarta-Ant and Xerces installed, you can install SableCC with the command:

	ant -Dinstall.dir=destination install
    

If you want to manually install SableCC, you must copy (and edit) the files bin/sablecc and lib/sablecc.jar (or bin\sablecc.bat and lib\sablecc.jar) to an appropriate location, and set your PATH environment variable appropriately.

If you got sablecc-3-beta.3-src.tar.gz (sources-only package)

1. Decompress the file sablecc-3-beta.3-src.tar.gz:

   	  tar -xzvf sablecc-3-beta.3-src.tar.gz
         

2. Go into the in sablecc-3-beta.3 directory:

   	  cd sablecc-3-beta.3
         

3. If you want an automatic build process, you need to have Jakarta-Ant and Xerces installed. Simply type:

   	  ant -Dinstall.dir=destination install
         

SableCC is covered by the GNU Lesser General Public License. You can view the copyright notice and the exact terms of the license in the files LICENSE, AUTHORS and COPYING-LESSER.

You can find complete and detailed documentation on the SableCC framework and syntax at the following site: http://www.sablecc.org/.

The easiest way of obtaining help is to get on the SableCC mailing-list. Many SableCC users around the world are already on this mailing-list. This is the best pool of information available to you.

To get on the SableCC mailing-list, send an e-mail message to majordomo@sable.mcgill.ca. Put 'subscribe sablecc-list your@email.address' in the body of the message. Once you are on the list, you can send your questions.
You can also subscribe on the new SableCC mailing-list. To do so, go to http://www.sablecc.org/home/support.php and fill out the form ont this page.

You are very welcome to express your appreciation of SableCC through any kind of donation. If you would like to make a financial donation (or another kind of donation), or if you would like to fund further development of SableCC, please send an email to Etienne M. Gagnon (etienne.gagnon@uqam.ca). Thank you in advance.