Refactor(README): Add README.md and README_zh.md
This commit is contained in:
55
README.md
55
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
|
[Web UI of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-ui)
|
||||||
$ npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
### Development
|
[API of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-api)
|
||||||
|
|
||||||
```bash
|
[Android Client of Oxygen Toolbox](https://github.com/FatttSnake/oxygen-android)
|
||||||
$ npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
### Build
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# For windows
|
|
||||||
$ npm run build:win
|
|
||||||
|
|
||||||
# For macOS
|
|
||||||
$ npm run build:mac
|
|
||||||
|
|
||||||
# For Linux
|
|
||||||
$ npm run build:linux
|
|
||||||
```
|
|
||||||
|
|||||||
37
README_zh.md
Normal file
37
README_zh.md
Normal file
@@ -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)
|
||||||
1
doc/logo.svg
Normal file
1
doc/logo.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 6.9 KiB |
Reference in New Issue
Block a user