feat: 更新 README
This commit is contained in:
parent
d681beb1b4
commit
51c2352548
5 changed files with 46 additions and 40 deletions
43
README.md
43
README.md
|
|
@ -1,33 +1,36 @@
|
||||||
# 待办 | ToDo
|

|
||||||
简单的待办应用,遵循Material Design 3
|
# 待办
|
||||||
|
一个简单的、遵循 Material Design 3 的待办应用,使用 Jetpack Compose 编写
|
||||||
|
|
||||||
**简体中文** | [English](https://github.com/Super12138/ToDo/blob/main/README_EN.md)
|
**简体中文** | [English](https://github.com/Super12138/ToDo/blob/main/README_EN.md)
|
||||||
|
|
||||||
[](https://github.com/Super12138/ToDo/actions/workflows/android_ci.yml)
|
[](https://github.com/Super12138/ToDo/actions/workflows/android_ci.yml)
|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
# ⬆️ 版本支持
|
# 📦 版本支持
|
||||||
- Android 7.0(Nougat) - Android 14.0(UpsideDownCake)
|
支持 `Android 7.0 (Nougat)` 至 `Android 15.0 (VanillaIceCream)`
|
||||||
|
|
||||||
# ✨ 功能
|
# ✨ 功能
|
||||||
- 深色模式
|
- Jetpack Compose
|
||||||
- Material Design 3
|
- 基于 Material Design 3 设计的可自定义主题系统
|
||||||
- 待办进度条
|
|
||||||
- 多学科支持
|
- 多学科支持
|
||||||
- 作业输入预测(后续计划支持自定义预测项目)
|
- 任务优先级
|
||||||
- ……
|
- ……
|
||||||
|
|
||||||
# 📦 构建
|
|
||||||
推荐使用`Android Studio`进行构建
|
|
||||||
所需环境:
|
|
||||||
- Android Studio (AGP `8.2.1`)
|
|
||||||
- JDK `17`
|
|
||||||
- Kotlin `1.9.22`
|
|
||||||
- Gradle `8.5`
|
|
||||||
|
|
||||||
# ⬇️ 下载
|
# ⬇️ 下载
|
||||||
[Github Release](https://github.com/Super12138/ToDo/releases/)
|
[前往 GitHub Release](https://github.com/Super12138/ToDo/releases/)
|
||||||
|
|
||||||
|
或者从 F-Droid 上下载
|
||||||
|
[<img src="./art/get-it-on-fdroid-zh-cn.png" height="100" />](https://f-droid.org/packages/cn.super12138.todo)
|
||||||
|
|
||||||
|
# 📸 截图
|
||||||
|
|  |  |
|
||||||
|
| --- | --- |
|
||||||
|
| 主界面(浅色) | 主界面(深色) |
|
||||||
|
|  |  |
|
||||||
|
| 添加待办 | 正在完成待办的效果 |
|
||||||
|
|
||||||
|
|
||||||
# 📃 许可证
|
# 📃 许可证
|
||||||
[GPL-3.0](https://github.com/Super12138/ToDo/blob/main/LICENSE)
|
[GPL-3.0-only](https://github.com/Super12138/ToDo/blob/main/LICENSE)
|
||||||
|
|
|
||||||
41
README_EN.md
41
README_EN.md
|
|
@ -1,33 +1,36 @@
|
||||||
# 待办 | ToDo
|

|
||||||
A simple to-do app, with Material Design 3
|
# To Do
|
||||||
|
A simple to-do app that follows Material Design 3, using Jetpack Compose
|
||||||
|
|
||||||
[简体中文](https://github.com/Super12138/ToDo/blob/main/README.md) | **English**
|
[简体中文](https://github.com/Super12138/ToDo/blob/main/README.md) | **English**
|
||||||
|
|
||||||
[](https://github.com/Super12138/ToDo/actions/workflows/android_ci.yml)
|
[](https://github.com/Super12138/ToDo/actions/workflows/android_ci.yml)
|
||||||

|
|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
# ⬆️ Supported Versions
|
# 📦 Supported Versions
|
||||||
- Android 7.0(Nougat) - Android 14.0(UpsideDownCake)
|
From `Android 7.0 (Nougat)` to `Android 15.0 (VanillaIceCream)`
|
||||||
|
|
||||||
# ✨ Features
|
# ✨ Features
|
||||||
- Dark mode
|
- Jetpack Compose
|
||||||
- Material Design 3
|
- Customizable theming system based on Material Design 3
|
||||||
- To-do progress bar
|
|
||||||
- Multi-subject support
|
- Multi-subject support
|
||||||
- Homework input prediction
|
- Task priority
|
||||||
- ...
|
- ...
|
||||||
|
|
||||||
# 📦 Build
|
|
||||||
Recommend to use `Android Studio` for build
|
|
||||||
Environment:
|
|
||||||
- Android Studio (AGP `8.2.1`)
|
|
||||||
- JDK `17`
|
|
||||||
- Kotlin `1.9.22`
|
|
||||||
- Gradle `8.5`
|
|
||||||
|
|
||||||
# ⬇️ Download
|
# ⬇️ Download
|
||||||
[Github Release](https://github.com/Super12138/ToDo/releases/)
|
[From Github Release](https://github.com/Super12138/ToDo/releases/)
|
||||||
|
|
||||||
|
Or get it from F-Droid
|
||||||
|
[<img src="./art/get-it-on-fdroid.png" height="100" />](https://f-droid.org/packages/cn.super12138.todo)
|
||||||
|
|
||||||
|
|
||||||
|
# 📸 Screenshots
|
||||||
|
|  |  |
|
||||||
|
| --- | --- |
|
||||||
|
| Main page (Light) | Main page (Dark) |
|
||||||
|
|  |  |
|
||||||
|
| Add task page | The effect of completing a task |
|
||||||
|
|
||||||
# 📃 License
|
# 📃 License
|
||||||
[GPL-3.0](https://github.com/Super12138/ToDo/blob/main/LICENSE)
|
[GPL-3.0-only](https://github.com/Super12138/ToDo/blob/main/LICENSE)
|
||||||
|
|
@ -34,7 +34,7 @@ android {
|
||||||
applicationId = "cn.super12138.todo"
|
applicationId = "cn.super12138.todo"
|
||||||
minSdk = 24
|
minSdk = 24
|
||||||
targetSdk = 35
|
targetSdk = 35
|
||||||
versionCode = 551
|
versionCode = 555
|
||||||
versionName = "2.0.2"
|
versionName = "2.0.2"
|
||||||
|
|
||||||
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
|
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
|
||||||
|
|
|
||||||
BIN
art/get-it-on-fdroid-zh-cn.png
Normal file
BIN
art/get-it-on-fdroid-zh-cn.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
art/get-it-on-fdroid.png
Normal file
BIN
art/get-it-on-fdroid.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Loading…
Reference in a new issue