Skip to content

Commit 51eeae9

Browse files
committed
Adjust README.md
1 parent 822a697 commit 51eeae9

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,46 @@
1-
# MIO Debugger
2-
3-
[![DOI](https://zenodo.org/badge/893997044.svg)](https://doi.org/10.5281/zenodo.15758201)
4-
5-
The MIO _/maː.joː/_ debugger is a first of its kind multiverse debugger designed for debugging WebAssembly programs on the WARDuino virtual machine.
1+
# rCMD Debugger
2+
The rCMD (pronounced rCommand) debugger is a prototype remote concolic multiverse debugger designed for debugging WebAssembly programs on the WARDuino virtual machine.
63

74
## Dependencies
8-
To build MIO + WARDuino you will need the following dependencies:
5+
To build rCMD + WARDuino you will need the following dependencies:
96

10-
- Java 21
11-
- A modern C++ compiler
12-
- Cmake
13-
- Z3 for WARDuino's concolic mode
7+
- Java 21+
8+
- A C++ compiler supporting C++17
9+
- Cmake 3.15+
10+
- Z3
1411

1512
## Getting started
1613
> [!NOTE]
1714
> Currently only Linux and macOS are supported.
1815
19-
MIO uses the Gradle build system. To get started, `./gradlew setup` can be used. This will build MIO and WARDuino and create a default configuration file in `~/.mio/debugger.properties`.
16+
rCMD uses the Gradle build system. To get started, `./gradlew setup` can be used. This will build rCMD and WARDuino and create a default configuration file in `~/.rcmd/debugger.properties`.
2017

21-
The debugger can then be started by running `java -jar mio.jar` in the `build/libs` directory. To run MIO you will need Java 22 or higher.
18+
The debugger can then be started by running `java -jar rcmd.jar` in the `build/libs` directory. To run rCMD you will need Java 21 or higher.
2219

2320
```bash
2421
git clone --recursive git@github.com:TOPLLab/MIO.git
2522
cd MIO
2623
./gradlew setup
2724
cd build/libs
28-
java -jar mio.jar
25+
java -jar rcmd.jar
2926
```
3027

31-
More experienced users can also just build MIO by itself by using `./gradlew fatjar`. When doing so you will need to manually create a configuration file and provide or build your own copy of WARDuino. More information about the configuration file can be found below.
28+
More experienced users can also just build rCMD by itself by using `./gradlew fatjar`. When doing so you will need to manually create a configuration file and provide or build your own copy of WARDuino. More information about the configuration file can be found below.
3229

3330
## Configuration
3431
To use the debugger you will need a `debugger.properties` configuration file, this config currently needs to be positioned at
35-
`~/.mio/debugger.properties`. This config specifies where the debugger can find WARDuino, which USB port it should
32+
`~/.rcmd/debugger.properties`. This config specifies where the debugger can find WARDuino, which USB port it should
3633
use, if the debugger should run on an emulator or not and how big the UI should be. An example of this config file can
3734
be found [here](debugger.properties).
3835

3936
> [!NOTE]
4037
> The concolic option currently requires the usage of a modified WARDuino version which can be found on the `feat/symbolic-templated` branch. This branch houses the code for the concolic execution engine used for suggesting interesting paths.
4138
4239
## Command line arguments
43-
MIO has various command line arguments that can be used to flash and debug programs. We list these options here:
40+
rCMD has various command line arguments that can be used to flash and debug programs. We list these options here:
4441
- `repl` which starts up a debugger repl.
4542
- `debug` which starts up the graphical debugger, this option requires two arguments a `.wasm.map` and `.wasm` file. Example: `debug robotarm.wasm.map robotarm.wasm`.
4643
- `flash` which uploads the program provided as an argument and starts to run it on the microcontroller.
4744
- `run` same thing as flash but after uploading the module it will open a debugger repl.
4845

49-
If no option is specified, MIO will open a welcome screen allowing you to select the program you would like to debug using a graphical interface. This graphical window works similarly to the `debug` option.
46+
If no option is specified, rCMD will open a welcome screen allowing you to select the program you would like to debug using a graphical interface. This graphical window works similarly to the `debug` option.

0 commit comments

Comments
 (0)