Updated readme

This commit is contained in:
Mikael Degerfält 2019-06-23 13:34:19 +02:00
parent e46378f1a3
commit 315013eb2b

View file

@ -1,22 +1,22 @@
## Simulator for NuEVI
# Simulator for NuEVI
This is a simple SDL2 based simulator that runs the NuEVI firmware compiled for MacOS. This is for testing the menu and is not supposed to produce any midi events.
## Requirements
### Requirements
* The Filters library must be installed in ~/Documents/Arduino/libraries/Filters.
* SDL2 must be installed on your machine.
* You probably need to have XCode and XCodes command line tools installed as well.
* The Filters library must be installed in ~/Documents/Arduino/libraries/Filters.
* [SDL2.framework](https://www.libsdl.org/download-2.0.php) must be installed on your machine in /Library/Frameworks/ (or ~/Library/Frameworks/).
* You probably need to have XCode and XCodes command line tools installed as well, but using brew to install make and clang might be enough.
[Dear Imgui](https://github.com/ocornut/imgui) is pulled in as an git submodule. Run `git submodule init` and `git submodule update` to get the code. The code is tested with tag v1.70 of ImGui, so if you run into problems make sure that is the checked out version.
## Know limitations
### Know limitations
Currently only some input is simulated, and the default values are not based on real hardware. There is also a limitation on some keyboards on how many buttons can be pressed at the same time. This means that all menu functions cannot be tested.
Currently the only input simulated are the menu buttons (use the arrow keys). This means that all menu functions cannot be tested, since the rotator menu cannot be opened. There is also a limitation on some keyboard on how many buttons can be pressed at the same time.
## Future plans
### Future plans
* Add a Dear ImGUI based UI for simulating all other inputs.
* Add simulation for all inputs
* Show MIDI status in UI
* Add in-app log window
* Fake real breath input by keypress