Welcome to the CDX Compiler! This is a Rust-based compiler with an exciting journey ahead - we're planning to bootstrap a compiler for CDX in CDX itself. Here's a sneak peek into our roadmap.
The idea of writing a compiler for CDX in CDX is thrilling and challenging. We're laying down the groundwork for this ambitious project, and here's how we plan to approach it:
- We're planning a lexer that can tokenize CDX code beautifully, a parser that's sharp enough to build an AST, a semantic analyzer to keep our code in check, and a code generator that's the final piece of our puzzle.
- Our journey starts with simple functionality and will gradually climb to handle the complexities of CDX.
- Testing is at the heart of our development. We're building a robust suite of unit tests to ensure every component works flawlessly.
- We believe in clear documentation. As we build our compiler, we'll document every step to guide you and future contributors.
- It's all about taking small steps and testing rigorously. We'll be refining our compiler with regular testing.
- Our goal is a compiler that not only adheres to CDX specifications but also excels in performance and robustness.
Before you get started, you'll need:
- The Rust programming language.
- Cargo, which is Rust's package manager.
Here's how you can get up and running:
-
Clone our repository:
git clone https://github.com/severeduck/cdx.git
-
Jump into the project directory:
cd cdx_compiler -
Let's build the project:
cargo build --release
This step compiles everything and gets it ready for action.
Ready to use the CDX Compiler? Simply run the compiled binary with the necessary arguments. Check out the documentation or examples in the project for more detailed instructions on getting started.
If you're interested in building the compiler straight from the source, here's how:
cargo build --releaseYour fresh executable will be waiting for you in target/release.
Want to run our test suite? Just execute:
cargo testIt's always good to make sure everything is ticking along nicely!
If you're keen to dive into development, the src directory is your go-to place to understand the nuts and bolts of the CDX Compiler.
You'll find additional guidelines and standards for development in our project documentation.
We love contributions! If you're interested in contributing to the CDX Compiler, please take a look at the contributing guidelines for more information on how to get involved.
This project is all about open source and is licensed under the MIT License. Feel free to use, modify, and distribute it as you see fit.
A huge shoutout to all the contributors and supporters of the CDX Compiler project. We couldn't do it without you!