SableCC version @version@

ReadMe

Welcome to SableCC version @version@.

Please read this document carefully.

Content

top

Getting Started

content

Here are the minimal steps to get SableCC running.

  1. If it is not already done, download and install the Sun Java Development Kit (JDK) version 1.2 or newer from http://java.sun.com/.

  2. If it is not already done, download the binary version of SableCC ("sablecc-@version@-classes.jar") from http://sourceforge.net/projects/sablecc/.
  3. Now you are ready to run SableCC. Simply type:
    java -mx1024m -jar sablecc-@version@-classes.jar
          
    You should see a copyright notice, and a usage note. That's it!

License

content

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 and COPYING-LESSER.

Documentation

content

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

Source Code

content

You can download the source code of SableCC ("sablecc-@version@.tar.gz") from http://sourceforge.net/projects/sablecc/.

Getting Help

content

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.

Mailing-list

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.

Paid Support

If you have a pressing need for SableCC to include an additional feature that is key to your work, or if you want some help with a grammar, you can get paid support from the author of SableCC. For further information, send an email to Etienne M. Gagnon (egagnon@j-meg.com).

Bug reports and wish-list

You are welcome to send your comments and bug reports using the SableCC mailing-list. This helps improving SableCC.

Have fun!