add README

uttne · Apr 6, 2022 · d606ec3 · d606ec3
1 parent 0340357
commit d606ec3
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,32 @@
+# musicxmldiff
+
+musicxmldiff is "diff" for [MusicXML](https://www.musicxml.com/).
+
+![Demo](https://github.com/labocho/musicxmldiff/blob/master/demo.png?raw=true)
+
+# How to use
+
+1. Open https://musicxmldiff.penguinlab.jp/
+2. Select two MusicXML files to compare
+3. Select part
+
+
+# Limitation
+
+This version is "beta".
+
+* Don't support `<score-timewise>` data.
+* Don't support compressed data (.mxl).
+* May not display some objects over multiple measures (eg. cresc. or slurs)
+* Web app only (No desktop app).
+
+
+# Development
+
+    yarn install
+    yarn start
+
+# License
+
+See `LICENSE`
+
diff --git a/TODO.md b/TODO.md
diff --git a/src/App.vue b/src/App.vue
@@ -18,6 +18,9 @@
     </div>
   </nav>
   <div class="container mt-4">
+    <div class="mb-4">
+      <b class="text-danger">This version is "beta". Please see <a href="https://github.com/labocho/musicxmldiff/blob/master/README.md" target="_blank">limitation.</a></b>
+    </div>
     <div>
       <h4 class="mb-4">Select MusicXML files to compare</h4>
       <section class="d-flex">