Add compilation step, fix usage in README.

This commit is contained in:
Stefano Sanfilippo 2014-11-29 00:49:21 +01:00
parent 9aadddd2fa
commit 099aff1efc

View File

@ -8,12 +8,23 @@ comedy.
There is no way to translate a "supercazzola" to English, so if you don't speak There is no way to translate a "supercazzola" to English, so if you don't speak
Italian, I'm afraid you won't understand. I'm really sorry for you :) Italian, I'm afraid you won't understand. I'm really sorry for you :)
Compilation
===========
You will need `bison` version > 3.0, `flex` 2.5 or above and any C++11 compiler.
A makefile is provided and will compiler the `mcc` executable. Compiling the
executable is a matter of:
make
there are some other targets, which are of interest only for developers.
Usage Usage
===== =====
`mcc` is a source to source compiler, which reads Monicelli and outputs a `mcc` is a source to source compiler, which reads Monicelli and outputs a
subset of C++. For those of you anxious to code, the `examples/` folder subset of C++. For those of you who want to get to the code ASAP, the `examples/`
contains a set of programs covering most of the features of the language. folder contains a set of programs covering most of the features of the language.
A good wat to learn on the field is comparing the resulting C++ with the A good wat to learn on the field is comparing the resulting C++ with the
input. Well, mostly with the beautified version of the input, `*.beauty.mc`. input. Well, mostly with the beautified version of the input, `*.beauty.mc`.