alpha_tui

This is my attempt at writing a runtime environment and debugger for the Alpha-Notation used in my Systemnahe Informatik lecture at university.

Programs are read in and interpreted, a terminal ui is then opened where you can run the program line by line or by using breakpoints. It is also supported to start a playground environment by using the playground command.

Pull requests and bug reports are welcome. See CONTRIBUTING.md for further details.

Contents

1. Getting started
   • Compile from source
   • Using nix
2. Interface and usage
   • Load command
   • Playground command
   • Check command
   • Error handling
3. Instructions
   • Memory cells
   • Substitutions
   • Examples
4. CLI options
   • General options
   • Examples

Getting started

1. Download the newest release specific for your system
2. Extract the .zip file
3. Create a program by using the text editor of your choice or try an example program located in examples/programs. The examples might help you write your program.
4. Run alpha_tui by opening a terminal in the folder and then typing .\alpha_tui load FILENAME, for an example program this command could look like this: .\alpha_tui load examples/programs/faculty.alpha
5. The terminal ui will open where you can run the program line by line by using the [r] key

Compile from source

To compile the program from source the rust toolchain is needed (install via rustup). Once installed you can run the program by typing cargo run. To submit arguments you can use --, for example cargo run -- -h will print help.

Using nix

This Repository provides a flake. If you have flakes enabled you can use

nix shell github:lmh01/alpha_tui

to start a shell in which alpha_tui is installed.