From 84101abf5ca9682ec29d05b3bec1a60db39dcbb5 Mon Sep 17 00:00:00 2001 From: kairee Date: Sun, 22 Dec 2019 05:46:42 +0800 Subject: [PATCH] docs: add Chinese readme files --- README.md | 8 +++++--- README.zh_CN.md | 42 ++++++++++++++++++++++++++++++++++++++++++ README.zh_TW.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 92 insertions(+), 3 deletions(-) create mode 100644 README.zh_CN.md create mode 100644 README.zh_TW.md diff --git a/README.md b/README.md index ce7da16..395349a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # Web UI for ServerStatus +**English** | [简体中文](README.zh-CN.md) | [繁體中文](README.zh-TW.md) + This is a web ui for [BotoX's ServerStatus](https://github.com/BotoX/ServerStatus/). -[![GitHub](https://img.shields.io/github/license/krwu/ServerStatus-web)](https://github.com/krwu/ServerStatus-web/blob/master/COPYING.txt) +[![Build Status](https://travis-ci.com/krwu/ServerStatus-web.svg?branch=master)](https://travis-ci.com/krwu/ServerStatus-web) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/krwu/ServerStatus-Web) [![GitHub All Releases](https://img.shields.io/github/downloads/krwu/ServerStatus-web/total)](https://github.com/krwu/ServerStatus-web/releases) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) -[![Build Status](https://travis-ci.org/krwu/auto-release.svg?branch=master)](https://travis-ci.org/krwu/auto-release) - +[![GitHub](https://img.shields.io/github/license/krwu/ServerStatus-web)](https://github.com/krwu/ServerStatus-web/blob/master/COPYING.txt) +![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/krwu/ServerStatus-Web/react) ## Live demo: diff --git a/README.zh_CN.md b/README.zh_CN.md new file mode 100644 index 0000000..cda0ea2 --- /dev/null +++ b/README.zh_CN.md @@ -0,0 +1,42 @@ +# Web UI for ServerStatus + +[English](README.md) | **简体中文** | [繁體中文](README.zh_TW.md) + +本项目是为 [BotoX's ServerStatus](https://github.com/BotoX/ServerStatus/) 开发的前端展示界面. + +[![Build Status](https://travis-ci.com/krwu/ServerStatus-web.svg?branch=master)](https://travis-ci.com/krwu/ServerStatus-web) +![GitHub release (latest by date)](https://img.shields.io/github/v/release/krwu/ServerStatus-Web) +[![GitHub All Releases](https://img.shields.io/github/downloads/krwu/ServerStatus-web/total)](https://github.com/krwu/ServerStatus-web/releases) +[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) +[![GitHub](https://img.shields.io/github/license/krwu/ServerStatus-web)](https://github.com/krwu/ServerStatus-web/blob/master/COPYING.txt) +![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/krwu/ServerStatus-Web/react) + +## 演示: + +[https://udev.bid/sergate/](https://udev.bid/sergate/) + +## 使用方法: + +你必须首先成功安装和运行 [BotoX's ServerStatus](https://github.com/BotoX/ServerStatus/)。因为这个项目仅仅是一个可以即插即用的可替换的 web 界面。 + +### **使用预编译版:** + +1. 从 [release 页面](https://github.com/krwu/ServerStatus-web/releases)下载最新的预编译压缩包。 +2. 解压下载的文件。 +3. 把 `sergate` 目录下的所有文件上传到你的 ServerStatus 的 web 目录(推荐操作:你可以先删除**原目录**下除了 `json/status.json` 以外的所有文件)。 + +### **自己编译:** + +1. 你需要安装有 Node.js, npm 或者 yarn. +2. 克隆本项目,或者下载打包的源代码到你的机器。 +3. 进入项目根目录(或解压后的文件夹)。 +4. 通过 npm(推荐) 或者 yarn 安装依赖项。 +5. 执行 `npm run build` 来编译 web 文件: + ``` bash + git clone https://github.com/krwu/ServerStatus-web.git + cd ./ServerStatus-web/ + ## 你也可以用 yarn 代替下面的 npm + npm i + npm run build + ``` +6. 把 `build` 目录下的所有文件上传到你的 ServerStatus 的 web 目录(推荐操作:你可以先删除**原目录**下除了 `json/status.json` 以外的所有文件)。 diff --git a/README.zh_TW.md b/README.zh_TW.md new file mode 100644 index 0000000..da21e3c --- /dev/null +++ b/README.zh_TW.md @@ -0,0 +1,45 @@ +# Web UI for ServerStatus + +[English](README.md) | [简体中文](README.zh_CN.md) | **繁體中文** + +本專案是為 [BotoX's ServerStatus](HTTPs://github.com/BotoX/ServerStatus/) 開發的前端展示介面. + +[![Build Status](https://travis-ci.com/krwu/ServerStatus-web.svg?branch=master)](https://travis-ci.com/krwu/ServerStatus-web) +![GitHub release (latest by date)](https://img.shields.io/github/v/release/krwu/ServerStatus-Web) +[![GitHub All Releases](https://img.shields.io/github/downloads/krwu/ServerStatus-web/total)](https://github.com/krwu/ServerStatus-web/releases) +[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) +[![GitHub](https://img.shields.io/github/license/krwu/ServerStatus-web)](https://github.com/krwu/ServerStatus-web/blob/master/COPYING.txt) +![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/krwu/ServerStatus-Web/react) + + +## 演示: + +[HTTPs://udev.bid/sergate/](HTTPs://udev.bid/sergate/) + +## 使用方法: + +你必須首先成功安裝和運行 [BotoX's ServerStatus](HTTPs://github.com/BotoX/ServerStatus/)。 因為這個專案僅僅是一個可以隨插即用的可替換的 web 介面。 + +- ### **使用預編譯版:** + +1. 從 [release 頁面](HTTPs://github.com/krwu/ServerStatus-web/releases)下載最新的預編譯壓縮包。 +2. 解壓下載的檔。 +3. 把 `sergate` 目錄下的所有檔上傳到你的 ServerStatus 的 web 目錄(推薦操作:你可以先刪除**原目錄**下除了 `json/status.json` 以外的所有檔)。 + +- ### **自行編譯:** + +1. 你需要安裝有 Node.js, npm 或者 yarn. +2. 克隆本專案,或者下載打包的原始程式碼到你的機器。 +3. 進入專案根目錄(或解壓後的資料夾)。 +4. 通過 npm(推薦) 或者 yarn 安裝依賴項。 +5. 執行 `npm run build` 來編譯 web 檔: + ```bash + git 克隆HTTPs://github.com/krwu/ServerStatus-web.git + cd ./伺服器狀態-Web/ + ## 你也可以用 yarn 代替下面的 npm + npm i + npm 運行生成 + ``` +6. 把 `build` 目錄下的所有檔上傳到你的 ServerStatus 的 web 目錄(推薦操作:你可以先刪除**原目錄**下除了 `json/status.json` 以外的所有檔)。 + +