Commit e12d25fb authored by marton bognar's avatar marton bognar
Browse files

Add a simple readme

parent e37cce0b
# AutBound: Code generator for abstract syntax trees
## Usage
The executable can be used from the command line with the following arguments:
```
autbound SOURCE_FILE OUTPUT_LANGUAGE VARIABLE_TYPE OUTPUT_NAME
```
For example, if we want to generate a Haskell module called `FCoBase` from the FCo specification, using string-based variables, we would issue the command:
```
autbound "Specifications/FCo.txt" Haskell String FCoBase
```
This will generate the file `FCoBase.hs` in the current directory.
The following options are currently available:
- `OUTPUT_LANGUAGE`: `Haskell`, `OCaml`
- `VARIABLE_TYPE`: `DeBruijn`, `String`
## Language descriptions
Language descriptions are simple text files. They consist of four different parts:
- Import declarations
- Namespace declarations
- Sort declarations
- Native code
None of these sections are mandatory.
For examples of language descriptions, see the `Specifications` directory.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment