update README

Author: yjpark

README.md

@@ -1,20 +1,80 @@
-# notation
+# Fun Notation
 
-## DSL for notation writing, using proc-macro to write tabs easily
+## What's the idea?
 
-- https://github.com/dtolnay/syn
-- https://github.com/dtolnay/proc-macro-workshop
-- https://github.com/korken89/smlang-rs
-- https://blog.logrocket.com/macros-in-rust-a-tutorial-with-examples/
+This is my experimentation on musical notations.
 
+Want to create some applications to help me to visualize music, practice easier, and provide nicer way to show scores or tabs.
 
-# project template for web and native
+Some of current tried ideas:
 
-- https://bevy-cheatbook.github.io/platforms/wasm/cargo-make.html
-- https://github.com/mrk-its/bevy_webgl2_app_template
+### Colors for notes
 
-# Todo
+Colors are based on the relative notation.
 
-proc_macro performance issue
+(TODO: need more explanation and an image here)
+
+### Color and shapes for chords
+
+![Chords](docs/images/chords.png?raw=true)
+
+(TODO: need more explanation)
+
+### Guitar tabs to show both pitch and durations for notes
+
+![Guitar Tab](docs/images/guitar_tab.png?raw=true)
+
+(TODO: need more explanation)
+
+## What's implemented?
+
+### Guitar Tab + Melody + Lyrics
+
+Features:
+
+- audio for each notes, sound quality not good enough (esp. in browser)
+- guitar fretboard synced with current played notes
+- A/B repeat for selected bars
+
+
+![Notation Viewer](docs/images/notation_viewer.gif?raw=true)
+
+[Watch on Youtube](https://youtu.be/vxXcNSpCZ5Y)
+
+[Try in browser](https://www.amateurguitar.com/songs/scarborough-fair/)
+Note that the web version is only working in desktop browser, the touch input is not working on mobile browsers yet.
+
+Desktop versions will be released later.
+
+You can also build it by yourself, make sure follow the [Bevy Engine Setup](https://bevyengine.org/learn/book/getting-started/setup/) first.
+```
+cd app/notation_viewer
+cargo run --features native
+```
+
+## How it's built?
+
+The current version is writted in [Rust](https://www.rust-lang.org), on top of [Bevy Engine](https://bevyengine.org), started as a demo to learn both the language and the game engine, but got much progress and show some potentials quickly.
+
+At this moment, there is no visual editor yet, instead a DSL in Rust is created to write tabs (also serving learning purpose at the first place), it's far from perfect, and got me quite some headaches some time, but did learned a lot, and some part of it is really nice. Plan to write some blogposts later on this topic.
+
+## What's the plan?
+
+Will try to make the guitar tab part useful for myself first, do more experiments on visual representation for music, then maybe release some applications or maybe games in the future.
+
+----
+## Some Inspirations
+
+### [Chromesthesia Color for Notes](https://en.wikipedia.org/wiki/Chromesthesia)
+
+Most colorful notation systems using rainbow colors for notes, but I found this chromesthesia system is much better for me to feel the music, especially when apply the colors to chords.
+
+
+### [Hook Theory](https://www.hooktheory.com/)
+
+This is really awesome, have tons of materials for music learning, also has a very powerful web application.
+
+### [Groove Pizza](https://apps.musedlab.org/groovepizza/?museid=qD-Y91QD3&)
+
+Very nice web application to visualize rhythm.
 
-- https://github.com/rust-lang/rust/issues/65080