From f6c292ff254886b9be1b5d542fceff10d680df35 Mon Sep 17 00:00:00 2001
From: FatttSnake <fatttsnake@gmail.com>
Date: Sat, 26 Oct 2024 15:34:09 +0800
Subject: [PATCH] Refactor(README): Add README.md and README_zh.md

---
 README.md    | 55 +++++++++++++++++++++++++++-------------------------
 README_zh.md | 37 +++++++++++++++++++++++++++++++++++
 doc/logo.svg |  1 +
 3 files changed, 67 insertions(+), 26 deletions(-)
 create mode 100644 README_zh.md
 create mode 100644 doc/logo.svg

diff --git a/README.md b/README.md
index dc8c4c4..aa49574 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,37 @@
-# oxygen-desktop
+<div align="center">
+    <h1>
+        <img alt="Logo" src="doc/logo.svg" width="128">
+        <br>
+        <span>Desktop of Oxygen Toolbox</span>
+    </h1>
+</div>
+<div align="center">
+    <a href="https://github.com/FatttSnake/oxygen-desktop/actions/workflows/build.yml">
+        <img alt="Build" src="https://img.shields.io/github/actions/workflow/status/FatttSnake/oxygen-desktop/build.yml
+">
+    </a>
+    <a href="https://github.com/FatttSnake/oxygen-desktop/releases/latest">
+        <img alt="Release" src="https://img.shields.io/github/v/release/FatttSnake/oxygen-desktop">
+    </a>
+    <a href="LICENSE">
+        <img alt="LICENSE" src="https://img.shields.io/github/license/FatttSnake/oxygen-desktop">
+    </a>
+</div>
 
-An Electron application with React and TypeScript
+# Overview ([ZH](README_zh.md), EN)
 
-## Recommended IDE Setup
+This project is a desktop application of Oxygen Toolbox. Supports local installation of tools and supports native api.
 
-- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+# Requires (One of)
 
-## Project Setup
+- Linux
+- Windows
+- MacOS
 
-### Install
+# Related projects
 
-```bash
-$ npm install
-```
+[Web UI of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-ui)
 
-### Development
+[API of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-api)
 
-```bash
-$ npm run dev
-```
-
-### Build
-
-```bash
-# For windows
-$ npm run build:win
-
-# For macOS
-$ npm run build:mac
-
-# For Linux
-$ npm run build:linux
-```
+[Android Client of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-android)
diff --git a/README_zh.md b/README_zh.md
new file mode 100644
index 0000000..ed2e870
--- /dev/null
+++ b/README_zh.md
@@ -0,0 +1,37 @@
+<div align="center">
+    <h1>
+        <img alt="Logo" src="doc/logo.svg" width="128">
+        <br>
+        <span>Desktop of Oxygen Toolbox</span>
+    </h1>
+</div>
+<div align="center">
+    <a href="https://github.com/FatttSnake/oxygen-desktop/actions/workflows/build.yml">
+        <img alt="Build" src="https://img.shields.io/github/actions/workflow/status/FatttSnake/oxygen-desktop/build.yml
+">
+    </a>
+    <a href="https://github.com/FatttSnake/oxygen-desktop/releases/latest">
+        <img alt="Release" src="https://img.shields.io/github/v/release/FatttSnake/oxygen-desktop">
+    </a>
+    <a href="LICENSE">
+        <img alt="LICENSE" src="https://img.shields.io/github/license/FatttSnake/oxygen-desktop">
+    </a>
+</div>
+
+# 概述 (ZH, [EN](README.md))
+
+本项目是 Oxygen Toolbox 的桌面应用程序。支持工具本地安装，支持原生api。
+
+# 要求 (其中一个)
+
+- Linux
+- Windows
+- MacOS
+
+# 关联项目
+
+[Web UI of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-ui)
+
+[API of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-api)
+
+[Android Client of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-android)
diff --git a/doc/logo.svg b/doc/logo.svg
new file mode 100644
index 0000000..6b67342
--- /dev/null
+++ b/doc/logo.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1024 1024"><path d="M163.02222,512.46925c0-120.32665,148.19299-72.78997,99.83528-56.73616-52.82592,17.53717,3.63378,125.58865,18.88934,87.62713c33.53841-83.45605,46.12579,47.6319,85.48988,47.6319s118.37922-203.60678,140.67406-151.31284c79.98758,187.61591,112.95735-7.88122,147.96707,101.13525c35.29521,109.90545,69.93083-100.57107,86.31006-42.07384c12.83646,45.8445,32.071949,9.89985,48.34954-33.25533c18.309184-48.541344,71.33167-63.82206,71.33168,46.98389c0,190.31099-151.31284,349.42345-349.42345,349.42345s-349.423455-159.581652-349.42345-349.42345h-.00001Zm204.21451,7.54624c11.90208-.00001,20.79906,10.55427,20.79906,20.79905s-8.33525,20.79906-20.79905,20.79906-20.79906-10.2756-20.79906-20.79905s8.89698-20.79906,20.79905-20.79906Zm-20.79905-206.906c8.98327,0,15.69841,7.966,15.69841,15.69841s-6.29116,15.69841-15.69841,15.69841-15.69841-7.75567-15.69841-15.69841s6.71513-15.69841,15.69841-15.69841ZM283.6631,399.90118c7.38365,0,12.90304,6.54752,12.90304,12.90304s-5.17091,12.90304-12.90304,12.90304-12.90304-6.37465-12.90304-12.90304s5.51939-12.90304,12.90304-12.90304Zm150.92601-42.3338c19.80595,0,34.6112,17.56311,34.6112,34.6112s-13.87049,34.6112-34.6112,34.6112-34.6112-17.09939-34.6112-34.6112s14.80525-34.6112,34.6112-34.6112Zm253.87481,42.3338c15.97466,0,27.91596,14.16568,27.91596,27.91596s-11.18737,27.91596-27.91596,27.91596-27.91596-13.79166-27.91596-27.91596s11.9413-27.91596,27.91596-27.91596ZM331.77365,410.81435c5.19776,0,9.08316,4.60916,9.08316,9.08316s-3.64009,9.08316-9.08316,9.08316-9.08316-4.48746-9.08316-9.08316s3.8854-9.08316,9.08316-9.08316Zm208.4973-4.889257c9.59422,0,16.76605,8.50776,16.76605,16.76605s-6.71902,16.76605-16.76605,16.76605-16.76605-8.28313-16.76605-16.76605s7.17183-16.76605,16.76605-16.76605ZM595.57796,458.3984c14.37533,0,25.12112,12.74744,25.12112,25.12107s-10.06733,25.12107-25.12112,25.12107-25.12112-12.41087-25.12112-25.12107s10.74578-25.12107,25.12112-25.12107ZM423.529889,258.512076c8.78906,0,15.35902,7.79378,15.35902,15.35902s-6.15515,15.35902-15.35902,15.35902-15.35902-7.588-15.35902-15.35902s6.56996-15.35902,15.35902-15.35902ZM240.24369,609.45123c0,21.96764,17.4004,43.41792,43.41941,43.41792s43.41941-22.03199,43.41941-43.41792-18.57304-43.41792-43.41941-43.41792-43.41941,21.45028-43.41941,43.41792Zm43.41941-35.89644c20.54218,0,35.89777,18.21529,35.89777,35.89644s-14.38609,35.89644-35.89777,35.89644-35.89777-17.73435-35.89777-35.89644s15.35559-35.89644,35.89777-35.89644Zm311.17009,20.92398c0,17.38091,13.76725,34.35249,34.35356,34.35249s34.35355-17.43183,34.35355-34.35249-14.69504-34.35249-34.35356-34.35249-34.35355,16.97158-34.35355,34.35249Zm34.35355-26.69037c15.27375,0,26.69111,13.54376,26.69111,26.69037s-10.6965,26.69037-26.69111,26.69037-26.69111-13.18617-26.69111-26.69037s11.41736-26.69037,26.69111-26.69037ZM327.15834,709.98512c0,7.72308,6.11718,15.26428,15.26428,15.26428s15.26428-7.74571,15.26428-15.26428-6.52943-15.26428-15.26428-15.26428-15.26428,7.5412-15.26428,15.26428Zm15.26428-10.64897c6.09378,0,10.64897,5.40371,10.64897,10.64897s-4.26759,10.64897-10.64897,10.64897-10.64897-5.26104-10.64897-10.64897s4.55519-10.64897,10.64897-10.64897Zm49.20971-72.6274c0,5.08288,4.02597,10.04605,10.04605,10.04605s10.04605-5.09777,10.04605-10.04605-4.29729-10.04605-10.04605-10.04605-10.04605,4.96317-10.04605,10.04605Zm10.04605-7.04378c4.03074,0,7.04378,3.5743,7.04378,7.04378s-2.82281,7.04378-7.04378,7.04378-7.04378-3.47992-7.04378-7.04378s3.01304-7.04378,7.04378-7.04378Zm240.08123,51.56982c0,5.08288,4.02597,10.04605,10.04605,10.04605s10.04605-5.09777,10.04605-10.04605-4.29729-10.04605-10.04605-10.04605-10.04605,4.96317-10.04605,10.04605Zm10.04605-7.04378c4.03074,0,7.04378,3.5743,7.04378,7.04378s-2.82281,7.04378-7.04378,7.04378-7.04378-3.47992-7.04378-7.04378s3.01304-7.04378,7.04378-7.04378Zm70.29015,7.04378c0,5.08288,4.02597,10.04605,10.04605,10.04605s10.04605-5.09777,10.04605-10.04605-4.29729-10.04605-10.04605-10.04605-10.04605,4.96317-10.04605,10.04605Zm10.04605-7.04378c4.03074,0,7.04378,3.5743,7.04378,7.04378s-2.82281,7.04378-7.04378,7.04378-7.04378-3.47992-7.04378-7.04378s3.01304-7.04378,7.04378-7.04378Zm-127.04051-9.72227c0,5.08288,4.02597,10.04605,10.04605,10.04605s10.04605-5.09777,10.04605-10.04605-4.29729-10.04605-10.04605-10.04605-10.04605,4.96317-10.04605,10.04605Zm10.04605-7.04378c4.03074,0,7.04378,3.5743,7.04378,7.04378s-2.82281,7.04378-7.04378,7.04378-7.04378-3.47992-7.04378-7.04378s3.01304-7.04378,7.04378-7.04378ZM459.34802,725.2494c0,5.08288,4.02597,10.04605,10.04605,10.04605s10.04605-5.09777,10.04605-10.04605-4.29729-10.04605-10.04605-10.04605-10.04605,4.96317-10.04605,10.04605Zm10.04605-7.04378c4.03074,0,7.04378,3.5743,7.04378,7.04378s-2.82281,7.04378-7.04378,7.04378-7.04378-3.47992-7.04378-7.04378s3.01304-7.04378,7.04378-7.04378Zm282.91106-113.4516c0,11.10817,8.7984,21.95473,21.95473,21.95473s21.95473-11.14071,21.95473-21.95473-9.39133-21.95473-21.95473-21.95473-21.95473,10.84656-21.95473,21.95473Zm21.95473-16.27759c9.31471,0,16.27759,8.2599,16.27759,16.27759s-6.52327,16.27759-16.27759,16.27759-16.27759-8.04182-16.27759-16.27759s6.96288-16.27759,16.27759-16.27759ZM479.31806,505.4742c0,11.10817,8.7984,21.95473,21.95473,21.95473s21.95473-11.14071,21.95473-21.95473-9.39133-21.95473-21.95473-21.95473-21.95473,10.84656-21.95473,21.95473Zm21.95473-16.27759c9.31471,0,16.27759,8.2599,16.27759,16.27759s-6.52327,16.27759-16.27759,16.27759-16.27759-8.04182-16.27759-16.27759s6.96288-16.27759,16.27759-16.27759ZM479.44012,664.69548c0,8.48291,6.71902,16.76605,16.76605,16.76605s16.76605-8.50776,16.76605-16.76605-7.17183-16.76605-16.76605-16.76605-16.76605,8.28313-16.76605,16.76605Zm16.76605-11.70461c6.69786,0,11.70461,5.93939,11.70461,11.70461s-4.69064,11.70461-11.70461,11.70461-11.70461-5.78257-11.70461-11.70461s5.00675-11.70461,11.70461-11.70461Zm167.69208,73.7603c0,8.48291,6.71902,16.76605,16.76605,16.76605s16.76605-8.50776,16.76605-16.76605-7.17183-16.76605-16.76605-16.76605-16.76605,8.28313-16.76605,16.76605Zm16.76605-11.70461c6.69786,0,11.70461,5.93939,11.70461,11.70461s-4.69064,11.70461-11.70461,11.70461-11.70461-5.78257-11.70461-11.70461s5.00675-11.70461,11.70461-11.70461ZM523.5049,560.12628c0,8.48291,6.71902,16.76605,16.76605,16.76605s16.76605-8.50776,16.76605-16.76605-7.17183-16.76605-16.76605-16.76605-16.76605,8.28313-16.76605,16.76605Zm16.76605-11.70461c6.69786,0,11.70461,5.93939,11.70461,11.70461s-4.69064,11.70461-11.70461,11.70461-11.70461-5.78257-11.70461-11.70461s5.00675-11.70461,11.70461-11.70461ZM434.58911,566.03331c0,8.48291,6.71902,16.76605,16.76605,16.76605s16.76605-8.50776,16.76605-16.76605-7.17183-16.76605-16.76605-16.76605-16.76605,8.28313-16.76605,16.76605Zm16.76605-11.71187c6.70201,0,11.71187,5.94307,11.71187,11.71187s-4.69355,11.71187-11.71187,11.71187-11.71187-5.78616-11.71187-11.71187s5.00986-11.71187,11.71187-11.71187ZM578.35895,203.134695c46.94729,0,77.99631,35.53165,77.99631,77.99631s-33.7984,77.99631-77.99631,77.99631-77.99631-35.53165-77.99631-77.99631s31.04902-77.99631,77.99631-77.99631Z" fill="#fff"/></svg>