更新文档

Wscats · Aug 5, 2019 · c19bef0 · c19bef0
1 parent a785af1
commit c19bef0
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 <div align="center">
-<p><img width="150" src="./public/logo.png"></p>
+<!-- <p><img width="150" src="./public/logo.png"></p> -->
 
 <h1>Omi Piano</h1>
 
+
 <p>
   <strong>Build piano with Omi and Omi Snippets</strong>
   <br /><br />
@@ -15,6 +16,7 @@
   -->
 </p>
 
+
 <p>
   <sub>Made with ❤︎ by
     <a href="https://github.com/Wscats">Eno Yao</a>
@@ -30,13 +32,15 @@
 
 </div>
 
-# Demo Address
+<img src="./public/demo.png">
+
+# Usage
 
 [演示地址](https://wscats.github.io/piano/build/)，代码打久了，放开双手远离屏幕，让`Omi`为你演奏几首钢琴曲，如果您喜欢的话，请点个赞吧~
 
 # Develop
 
-<img src="./public/demo.png">
+<!-- <img src="./public/demo.png"> -->
 
 ```bash
 # 获取远程仓库代码
@@ -50,14 +54,35 @@ npm start
 # 在浏览器访问 http://localhost:3000
 ```
 
-# Release
+# Installation
+
+Use the package manager npm to install.
+使用 npm 包管理器安装。
 
-发布属于自己的演奏版本
 ```bash
+npm install omi-piano
+```
+
+run or release.
+运行或者发布属于自己的演奏版本。
+
+
+```bash
+# 进入目录
+cd omi-piano
+# 安装依赖
+npm install
+# 启动项目
+npm start
+# 发布自已的演奏版本
 npm run build
 ```
 
-# License
+# Contributing
 
-MIT 
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
+Please make sure to update tests as appropriate.
+
+# License
+[MIT](https://choosealicense.com/licenses/mit/)
diff --git a/build/asset-manifest.json b/build/asset-manifest.json
@@ -1,5 +1,5 @@
 {
-  "index.js": "./static/js/index.3d0fe045.js",
-  "index.js.map": "./static/js/index.3d0fe045.js.map",
+  "index.js": "./static/js/index.5c89fff7.js",
+  "index.js.map": "./static/js/index.5c89fff7.js.map",
   "index.html": "./index.html"
 }
diff --git a/build/index.html b/build/index.html
@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name="theme-color" content="#000000"><link rel="manifest" href="./manifest.json"><link rel="shortcut icon" href="./favicon.ico"><title>Piano</title></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script src="./static/js/index.3d0fe045.js"></script></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name="theme-color" content="#000000"><link rel="manifest" href="./manifest.json"><link rel="shortcut icon" href="./favicon.ico"><title>Piano</title></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script src="./static/js/index.5c89fff7.js"></script></body></html>
diff --git a/build/service-worker.js b/build/service-worker.js
diff --git a/build/static/js/index.3d0fe045.js.map b/build/static/js/index.3d0fe045.js.map
diff --git a/build/static/js/index.3d0fe045.js → build/static/js/index.5c89fff7.js b/build/static/js/index.3d0fe045.js → build/static/js/index.5c89fff7.js
diff --git a/build/static/js/index.5c89fff7.js.map b/build/static/js/index.5c89fff7.js.map
diff --git a/public/demo.png b/public/demo.png
diff --git a/public/demo2.png b/public/demo2.png
diff --git a/src/elements/app-header/index.eno b/src/elements/app-header/index.eno
@@ -10,6 +10,8 @@
                         <a class="btn btn-outline-light btn-lg" href="https://github.com/Wscats/piano">View docs on
                             Github
                         </a>
+                        <a class="btn btn-outline-light btn-lg" href="https://github.com/Wscats/piano">查看该项目Github地址
+                        </a>
                     </div>
                 </div>
             </div>
@@ -111,6 +113,7 @@
     }
 
     a {
+        margin: 0 10px;
         text-decoration: none;
     }
 

diff --git a/src/elements/app-header/index.js b/src/elements/app-header/index.js
@@ -42,6 +42,14 @@ class AppHeader extends WeElement {
                   href: "https://github.com/Wscats/piano"
                 },
                 "View docs on Github"
+              ),
+              h(
+                "a",
+                {
+                  class: "btn btn-outline-light btn-lg",
+                  href: "https://github.com/Wscats/piano"
+                },
+                "\u67E5\u770B\u8BE5\u9879\u76EEGithub\u5730\u5740"
               )
             )
           )
@@ -175,6 +183,7 @@ AppHeader.css = `
     }
 
     a {
+        margin: 0 10px;
         text-decoration: none;
     }
 

diff --git a/src/elements/app-piano/index.eno b/src/elements/app-piano/index.eno
@@ -250,6 +250,7 @@
       playSong()
     }
     // 使用定时器弹奏
+    // playSongByInterval
     playSong(song) {
       clearInterval(this.interval)
       let offset = 0
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name="theme-color" content="#000000"><link rel="manifest" href="./manifest.json"><link rel="shortcut icon" href="./favicon.ico"><title>Piano</title></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script src="./static/js/index.3d0fe045.js"></script></body></html>
		<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name="theme-color" content="#000000"><link rel="manifest" href="./manifest.json"><link rel="shortcut icon" href="./favicon.ico"><title>Piano</title></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script src="./static/js/index.5c89fff7.js"></script></body></html>
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,8 @@ @@
                             <a class="btn btn-outline-light btn-lg" href="https://github.com/Wscats/piano">View docs on
                                 Github
                             </a>
+                            <a class="btn btn-outline-light btn-lg" href="https://github.com/Wscats/piano">查看该项目Github地址
+                            </a>
                         </div>
                     </div>
                 </div>
@@ Expand Down Expand Up / @@ -111,6 +113,7 @@ @@
         }
         a {
+            margin: 0 10px;
             text-decoration: none;
         }
@@ Expand Down @@