SableCC version @version@

Welcome to SableCC version @version@.

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-@version@.tar.gz (or sablecc-@version@.zip)

1. Decompress the file sablecc-@version@.tar.gz (or sablecc-@version@.zip):

   	  tar -xzvf sablecc-@version@.tar.gz
   	  

   or

   	  jar -xvf sablecc-@version@.zip
         

2. Go into the in sablecc-@version@ directory:

   	  cd sablecc-@version@
         

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 got sablecc-@version@-src.tar.gz (sources-only package)

1. Decompress the file sablecc-@version@-src.tar.gz:

   	  tar -xzvf sablecc-@version@-src.tar.gz
         

2. Go into the in sablecc-@version@ directory:

   	  cd sablecc-@version@
         

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 SableCCframework 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.

If you enjoy SableCC, and you would like to make a financial donation (or any another kind of donation), or if you would like to fund further development of SableCC, your are welcome to do so. Please send an email to Etienne M. Gagnon (egagnon@j-meg.com) explaining your intentions. I will be glad to help you reach your noble goals.