diff --git a/README.md b/README.md new file mode 100644 index 0000000..dcbe6da --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +rxcc - Rochester X C Compiler +--- +An x86 C compiler written in Swift. + +##Overview## +Have you ever woken up one day and said to yourself, "Man, I'd really like to build a compiler today."? +Could be just me. +Well, ever since that fateful day, I've been chiseling away at this mammoth task, adding functionality in stages by following [this series](https://norasandler.com/2017/11/29/Write-a-Compiler.html). + +##Features## +This project is under active development, but here is a lost of the currently implemented C language features: +* __Unary Operators__: The ~ (bitwise compliment), - (negation), and ! (logical negation) are implemented for integers, and can be applied to any term. +* __Arithmetic Operators__: The + (addition), - (subtraction), * (multiplication), and / (division) are implemented for integers, parsed according to their precedence levels in C. +* __Functions__: Each file currently supports exactly one function (so you'd be wise to make it "main"), with exactly one statement: an integer return statement. So yeah, not so useful yet. +* __Variables__: To be implemented soon.