teascade/reid-llvm
1
1
Fork 0
Code Issues Pull Requests Packages Releases 6 Wiki Activity

Update readme

Browse Source
This commit is contained in:
Sofia 2025-07-26 15:37:49 +03:00
parent 6f5bb51e3b
commit abe3fcd6fb
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -9,14 +9,26 @@ contains the relevant abstraction to produce a more Rust'y API from that.
Much of the syntax in Reid is directly inspired by rust, but mostly it is driven Much of the syntax in Reid is directly inspired by rust, but mostly it is driven
by simplicity. by simplicity.
Specifications and documentation for the language can be found
[here](./documentation/).
Reid is currently able to (non-exhaustively): Reid is currently able to (non-exhaustively):
- Do basic algebra (e.g. Add, Sub, Mult) - Do basic algebra binary and unary-operations (e.g. Add, Sub, Div, Mult, And,
Not)
- Resolve complex one-liners correctly using PEDMAS (e.g. `5 + 2 * 5 - 5 * - Resolve complex one-liners correctly using PEDMAS (e.g. `5 + 2 * 5 - 5 *
5` is calculated correctly) 5` is calculated correctly)
- Handle borrows/derefs, pointers.
- Declare and call functions with varying parameters and return types - Declare and call functions with varying parameters and return types
- Perform type-checking and type-inference such that return-types and - Perform type-checking and type-inference such that return-types and
parameter types must always match. parameter types must always match.
- Do simple logic-operations (e.g. If/And/Or) - Do simple logic-operations (e.g. If/And/Or)
- Handle, access, define and initialize structs and arrays.
- Define and execute For/While loops
- Output detailed debug information
- Define extern functions that can be linked to outside modules such as `libc`.
- Define custom binary operations for any two types that hasn't been defined
previously (such as `u16 + u32`).
An example program of Reid, that calculates the 5th fibonacci number (and uses An example program of Reid, that calculates the 5th fibonacci number (and uses
Rust for highlighting) is: Rust for highlighting) is: