diff --git a/README.md b/README.md index 1e146e5..050d502 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,39 @@ # Arcaea Offline -> 接受 lrlowiro 的一切 +English | [简体中文](./README.zh_Hans.md) -![Excel | Eternity](./assets/excel_eternity.png "Excel | Eternity") + + + + +> Accept lrlowiro ## WIP -This project is under active development, thus it is unstable and API may change frequently. +> **Warning** +> This project is under active development, thus it is unstable and API may change frequently. -## 这事什么? +## What is this? -这是用于计算 [Arcaea](https://arcaea.lowiro.com/) 中,玩家潜力值的 [B30 和 R10](https://wiki.arcaea.cn/潜力值#整体潜力值计算) 部分的程序。 +This is the core library of `Arcaea Offline`, designed to manage player scores, calculate their potential, and provide various useful tools. -## 这怎么用? +## How to use this? -这个存储库是相对基础的,提供操作数据库等“底层”操作的 python 库。要使用该库,请查阅 API 手册(还没写)。 +This repository is a python library. -如果您正寻找 GUI,请前往 [283375/arcaea-offline-pyside-ui](https://github.com/283375/arcaea-offline-pyside-ui) 了解详情。 +For general users, if you don't know what is a "library", you may be interested about [this GUI](https://github.com/283375/arcaea-offline-pyside-ui). + +For developers, the documentation is under construction. Check back later! + +## License + +This file is part of arcaea-offline. + +arcaea-offline is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + +arcaea-offline is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with arcaea-offline. If not, see . ## Credits diff --git a/README.zh_Hans.md b/README.zh_Hans.md new file mode 100644 index 0000000..c0e4cdf --- /dev/null +++ b/README.zh_Hans.md @@ -0,0 +1,38 @@ +# Arcaea Offline + + + + + +> 接受 lrlowiro 的一切 + +## WIP + +> **Warning** +> 该项目正处于早期开发阶段,不能保证稳定性,且 API 可能随时变动。 + +## 这是什么? + +这是 `Arcaea Offline` 的核心依赖库,用于维护分数数据库、计算潜力值,并提供一些实用工具。 + +## 这怎么用? + +该仓库是一个 python 库。 + +对普通用户,如果你不知道“库”是什么,你应该对[这个 GUI](https://github.com/283375/arcaea-offline-pyside-ui) 更感兴趣。 + +对开发者,文档仍在建设当中,敬请期待。 + +## 许可声明 + +本文件是 arcaea-offline 的一部分。 + +arcaea-offline 是自由软件:你可以再分发之和/或依照由自由软件基金会发布的 GNU 通用公共许可证修改之,无论是版本 3 许可证,还是(按你的决定)任何以后版都可以。 + +发布 arcaea-offline 是希望它能有用,但是并无保障;甚至连可销售和符合某个特定的目的都不保证。请参看 GNU 通用公共许可证,了解详情。 + +你应该随程序获得一份 GNU 通用公共许可证的复本。如果没有,请看 。 + +## Credits + +[Arcaea-Infinity/ArcaeaSongDatabase](https://github.com/Arcaea-Infinity/ArcaeaSongDatabase) diff --git a/assets/banner.png b/assets/banner.png new file mode 100644 index 0000000..a18a6a6 Binary files /dev/null and b/assets/banner.png differ diff --git a/assets/excel_eternity.png b/assets/excel_eternity.png deleted file mode 100644 index 74855b9..0000000 Binary files a/assets/excel_eternity.png and /dev/null differ diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 0000000..b1ee9ba --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1,84 @@ + + + + + + + + + + + + + + + + + + + + + + + + +