Update readme with eyecandy

SwadicalRag · Jan 8, 2021 · acfc846 · acfc846
1 parent d6995a9
commit acfc846
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,42 @@
 # Muon
 
-A GUI for the [Neutrino neural singing synthesizer](https://n3utrino.work), written in Flutter.
+A GUI for the [Neutrino neural singing synthesizer](https://n3utrino.work), written in Flutter (and uses [synaps](https://github.com/SwadicalRag/synaps)!).
+
+## Eyecandy / screenshots
+
+### ~~Eye-burning~~ Light mode
+![Light UI](eyecandy/light_ui.png)
+
+### Dark mode
+![Dark UI](eyecandy/dark_ui.png)
+
+### Features
+
+#### Seamless romaji -> hiragana voice editing
+![Lyric editing](eyecandy/lyric_editing.png)
+
+### Multiple voices rendered in parallel
+![Multiple voices](eyecandy/multi_voice.png)
+
+### Automatic voice model listing and on-the-fly changing
+![Voice Model Changing](eyecandy/voice_model_change.png)
+
+### MIDI/MusicXML import
+![MIDI Import](eyecandy/midi_import.png)
+![MusicXML Import](eyecandy/musicxml_import.png)
+
 
 ## Usage
 
 Coming soon!
 
 ## Changelog
 
+### [08/01/2021] 0.0.3 - Minimum releasable candidate
+ - Cleaned up code, abstracted pianoroll to facilitate any future extensions (e.g. f0/mgc editing)
+ - Upgraded to use the synaps state management library (and as a result cleaned up more code!)
+ - Fixed bugs with note dragging across semitones
+
 ### [05/01/2021] 0.0.2 - Proof of concept
  - Cleaned up code, documented many functions and classes
  - Fixed a bug with the flutter_desktop_audio plugin that caused deadlocks
@@ -20,7 +49,7 @@ Coming soon!
 Building Steps: 
 1. Clone this repository somewhere
 2. `flutter pub get` -> gets all packages
-3. `flutter pub run build_runner build` -> build the generated files for json_serializable
+3. `flutter pub run build_runner build` -> build the generated files for json_serializable/synaps
 4. `flutter build windows/macos/linux`
 5. *sigh* just read this https://flutter.dev/desktop#distribution
 

diff --git a/eyecandy/dark_ui.png b/eyecandy/dark_ui.png
diff --git a/eyecandy/light_ui.png b/eyecandy/light_ui.png
diff --git a/eyecandy/lyric_editing.png b/eyecandy/lyric_editing.png
diff --git a/eyecandy/midi_import.png b/eyecandy/midi_import.png
diff --git a/eyecandy/multi_voice.png b/eyecandy/multi_voice.png
diff --git a/eyecandy/musicxml_import.png b/eyecandy/musicxml_import.png
diff --git a/eyecandy/voice_model_change.png b/eyecandy/voice_model_change.png