_ __ _ _ _
| |/ /__ _| |_| |__ | | ___ ___ _ __
| ' // _` | __| '_ \| |/ _ \/ _ \ '_ \
| . \ (_| | |_| | | | | __/ __/ | | |
|_|\_\__,_|\__|_| |_|_|\___|\___|_| |_|
COMPILER by Ornithopter747
This is a small compiler that is in the works. It compiles a made up low-level programming language into an executable output for x64 Linux.
There are no releases yet so to try this program you have to build it yourself.
- Linux x64 required
- Install NASM and GCC
- Clone this repository
- Run
cargo build - You'll find the executable in
target/debug/kathleen.
(in these examples I will assume you added <path/to/project>/target/debug to your path.)
To display the help menu run
kathleenor
kathleen helpTo compile a program run
kathleen <src> <output-name> [options]For example:
kathleen hello.kl helloThis will create an executable you can run with ./hello out of your program in hello.kl.
To learn about the language's syntax or anything related to writing in it, check out language.md or examples.
You can download the syntax highlighting extension here.
All documentation and information can either be found in the code itself, or in the docs directory for higher-level information. NOTE: this is not information meant for the user, it is information about the project.
If you are having trouble, or if something is unclear, you can create an issue and ask for help using the quesition / documentation issue template.
If you encounter any issues using this program, create a github issue and use the bug report template.
If you want to propose any suggestions you are free to do so, you can use the feature request template.
If you want to try and solve an issue yourself, check out Contribute
Once the language will have taken its basic shape, and any help will be greatly appreciated. As of now I want to work on this by myself.
This project is licenced under the MIT license. In short, this means you are free to copy, use and distribute this program as long as you include the LICENSE in your own project.