diff --git a/README.md b/README.md index dc8c4c4..aa49574 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,37 @@ -# oxygen-desktop +
+

+ Logo +
+ Desktop of Oxygen Toolbox +

+
+
+ + Build + + + Release + + + LICENSE + +
-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 @@ +
+

+ Logo +
+ Desktop of Oxygen Toolbox +

+
+
+ + Build + + + Release + + + LICENSE + +
+ +# 概述 (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 @@ +