Note: We recommend using a Markdown previewer when reading these docs. We prefer VS Code's Preview mode. (Cmd+Shift+V on Mac, Ctrl+Shift+V on Windows)
To compile the transpiler, run:
makeThen you can run the transpiler and give it your MatLang program's path:
./matlang2c path/to/program.matThis will write the C code output to path/to/program.c or print Error (Line x) if a compile-time error occurs.
| Warning | Our preamble definitions are required for the output file to compile. |
|---|
If your MatLang program is not in the same directory as our source code, please COPY the preamble definition file preamble.h to that directory:
cp preamble.h path/to/program_dirAfter you have the preamble declarations file in the same directory, make sure to link with the math library when compiling the output program:
| Warning | Output program needs to be linked to the math library. |
|---|
Example command:
gcc prog.c -lm -o progTo run the tests:
make test
The docs don't end here. We have docpages explaining our testing suite and the code structure. Please check them out.
For test documentation, check test docs out.
For architecture and code organization, check architecture docs out.
For the structure and nesting of ASTNodes in the parser, check parser diagrams out.