If you want to build, test and run RTeasy-Online locally, you need to install a few things.
-
Rust: Rust is basically required for everything and can be installed from here.
-
Node and npm: Node and npm are required to build the IDE and can be installed from here.
-
mdbook: mdbook is required to build the book. It can be installed by executing the command
cargo install mdbook
. -
ghdl: ghdl is required to run the vhdl tests and can be installed from here.
This repository contains the complete source code for RTeasy-Online and is divided into the following components:
-
Backend: The backend contains the core logic for RTeasy. Here you can find among others the parser, compiler and simulator. All code in here is frontend agnostic and can be used from a graphical as well as from a console-based interface. The API Docs for the backend are built automatically.
-
IDE: The IDE is a graphical frontend built on top of the backend.
-
CLI: The CLI is a console-based frontend built on top of the backend.
-
Book: The book is the best way to get started with RTeasy-Online. It contains a tutorial and detailed explanations of all possible errors that can occur when compiling RTeasy programs.
-
VHDL Tests: Here you can find tests for the VHDL export of RTeasy-Online. Various examples are compiled to VHDL and then tested with ghdl.
-
Wasm: Small wrapper around the backend to make it accessible from Wasm. It makes use of wasm-bindgen. This is mainly used for the IDE.