diff --git a/README.en.md b/README.en.md index 10a45b7..6abd11e 100644 --- a/README.en.md +++ b/README.en.md @@ -19,9 +19,11 @@ ## ✨ Feature - **Cross-platform support**：🌍 Compatible with Android, iOS\*, Windows\*, MacOS\*, Linux. -- **Material Design**：🎨 The interface is intuitive and user-friendly, and follows the Material Design specifications. +- **Material Design**：🎨 The interface is intuitive and user-friendly, and follows the Material + Design specifications. - **Rich text editing**：📝 Supports text editing in bold, italic, underline and other formats. -- **Multimedia accessories**：📷 You can add pictures, audio, video or even draw a picture to your diary. +- **Multimedia accessories**：📷 You can add pictures, audio, video or even draw a picture to your + diary. - **Search and classification**：🔍 Easily manage your diary by full-text search and categorization. - **Custom theme**：🌈 Supports light and dark modes, as well as a variety of color schemes. - **Data security**：🔒 Keep your diary safe with a password, supports biometric unlocking. @@ -48,17 +50,26 @@ your own signatures) ### Mobile -![Mobile](res/screenshot/mobile.webp) + + + + The mobile screenshot for moodiary. + ### Desktop -![Desktop](res/screenshot/desktop.webp) + + + + The desktop screenshot for moodiary. + ## 🚀 Installation guide ### Third party SDK -Some capabilities need to apply for third-party SDKS, and the following service providers provide free versions, and the obtained keys are configured in the lab. +Some capabilities need to apply for third-party SDKS, and the following service providers provide +free versions, and the obtained keys are configured in the lab. #### Weather service @@ -74,7 +85,8 @@ Some capabilities need to apply for third-party SDKS, and the following service ### Direct mounting -Use it by downloading the compiled installation package in Release, or manually compiling it if you don't have the platform you need. +Use it by downloading the compiled installation package in Release, or manually compiling it if you +don't have the platform you need. ### Manual compilation @@ -88,7 +100,8 @@ Use it by downloading the compiled installation package in Release, or manually #### Installation procedure -> Note: When packaging, you need to modify the corresponding platform configuration file, such as Android platform build.gradle +> Note: When packaging, you need to modify the corresponding platform configuration file, such as +> Android platform build.gradle 1. **Clone Repo**： @@ -111,10 +124,10 @@ Use it by downloading the compiled installation package in Release, or manually 4. **Package release**： - - Android: `flutter build apk` - - iOS: `flutter build ipa` - - Windows: `flutter build windows` - - MacOS: `flutter build macos` + - Android: `flutter build apk` + - iOS: `flutter build ipa` + - Windows: `flutter build windows` + - MacOS: `flutter build macos` ## 📝 More description @@ -122,13 +135,20 @@ Use it by downloading the compiled installation package in Release, or manually > In the experimental stage -Today, more and more industry products are beginning to incorporate AI technology, which undoubtedly greatly improves our experience. However, for diary applications, it is not acceptable to hand over the data to a large model because it is not certain that the data will be used for training. Therefore, a better approach is to adopt a local model. Although local models may not be as powerful as large models due to size limitations, they can still provide necessary help to a certain extent. +Today, more and more industry products are beginning to incorporate AI technology, which undoubtedly +greatly improves our experience. However, for diary applications, it is not acceptable to hand over +the data to a large model because it is not certain that the data will be used for training. +Therefore, a better approach is to adopt a local model. Although local models may not be as powerful +as large models due to size limitations, they can still provide necessary help to a certain extent. Currently, I have the following tasks integrated into the source code: #### SQuAD task based on Bert pre-trained model -I used MobileBert for the SQuAD task, which is a simple machine reading comprehension task. You can ask it questions and it will return the answers you need. The model files are in the `.tflite` format required by TensorFlow Lite, so you can add your own model files to the `assets/tflite` directory. +I used MobileBert for the SQuAD task, which is a simple machine reading comprehension task. You can +ask it questions and it will return the answers you need. The model files are in the `.tflite` +format required by TensorFlow Lite, so you can add your own model files to the `assets/tflite` +directory. Thanks to the following open source projects: @@ -146,7 +166,9 @@ Contributions are welcome! Please follow these steps to contribute: 4. Push to branch(`git push origin feature-branch-name`)。 5. Create a Pull Request. -Please make sure that your code to follow [Flutter style guide](https://flutter.dev/docs/development/tools/formatting) and include the appropriate tests. +Please make sure that your code to +follow [Flutter style guide](https://flutter.dev/docs/development/tools/formatting) and include the +appropriate tests. ## 📄 License @@ -165,9 +187,13 @@ You can buy me a sandwich to keep me motivated to continue developing. ### List of sponsors -If you want to be on the list, you can leave me a message, in no particular order. +If you want to be on the list, you can leave me a message, in no particular order, and the list will +be updated regularly. -| Sponsor | Price | -|---------------------------------------|--------| -| [dsxksss](https://github.com/dsxksss) | 50 CNY | +| Sponsor | Price | Sponsor | Price | +|---------------------------------------|----------|---------|--------| +| [dsxksss](https://github.com/dsxksss) | 50 CNY | 十一 | 20 CNY | +| 沭飏秋 | 10 CNY | 朱东杰 | 60 CNY | +| 匿名 | 5 CNY | wu | 10 CNY | +| 云烨 | 2.76 CNY | | | diff --git a/README.md b/README.md index aaaf43d..ec8ad3e 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,19 @@ ### 移动端 -![移动端](res/screenshot/mobile.webp) + + + + The mobile screenshot for moodiary. + ### 桌面端 -![桌面端](res/screenshot/desktop.webp) + + + + The desktop screenshot for moodiary. + ## 🚀 安装指南 @@ -109,9 +117,9 @@ 4. **打包发布**： - Android: `flutter build apk` - - iOS: `flutter build ipa` + - iOS: `flutter build ipa` - Windows: `flutter build windows` - - MacOS: `flutter build macos` + - MacOS: `flutter build macos` ## 📝 更多说明 @@ -119,13 +127,15 @@ > 处于实验阶段 -如今，越来越多的行业产品开始融入 AI 技术，这无疑极大地提升了我们的使用体验。然而，对于日记应用来说，将数据交给大型模型处理并不可接受，因为无法确定这些数据是否会被用于训练。因此，更好的方法是采用本地模型。虽然由于体积限制，本地模型的能力可能不如大型模型强大，但在一定程度上仍能为我们提供必要的帮助。 +如今，越来越多的行业产品开始融入 AI +技术，这无疑极大地提升了我们的使用体验。然而，对于日记应用来说，将数据交给大型模型处理并不可接受，因为无法确定这些数据是否会被用于训练。因此，更好的方法是采用本地模型。虽然由于体积限制，本地模型的能力可能不如大型模型强大，但在一定程度上仍能为我们提供必要的帮助。 目前，我在源码中集成了以下任务： #### 基于 Bert 预训练模型的 SQuAD 任务 -我采用了 MobileBert 来处理 SQuAD 任务，这是一个简单的机器阅读理解任务。你可以向它提出问题，它会返回你需要的答案。模型文件采用 TensorFlow Lite 所需的 `.tflite` 格式，所以你可以添加自己的模型文件到 `assets/tflite` 目录下。 +我采用了 MobileBert 来处理 SQuAD 任务，这是一个简单的机器阅读理解任务。你可以向它提出问题，它会返回你需要的答案。模型文件采用 +TensorFlow Lite 所需的 `.tflite` 格式，所以你可以添加自己的模型文件到 `assets/tflite` 目录下。 感谢以下开源项目： @@ -143,7 +153,8 @@ 4. 推送到分支（`git push origin feature-branch-name`）。 5. 创建一个 Pull Request。 -请确保你的代码遵循 [Flutter 风格指南](https://flutter.dev/docs/development/tools/formatting) 并包含适当的测试。 +请确保你的代码遵循 [Flutter 风格指南](https://flutter.dev/docs/development/tools/formatting) +并包含适当的测试。 ## 📄 许可证 @@ -162,9 +173,12 @@ ### 捐助者名单 -如果您想要出现在名单中，可以给我留言，排名不分先后。 +如果您想要出现在名单中，可以给我留言，排名不分先后，名单会定期更新。 -| 捐助者 | 金额 | -|---------------------------------------|--------| -| [dsxksss](https://github.com/dsxksss) | 50 CNY | +| 捐助者 | 金额 | 捐助者 | 金额 | +|---------------------------------------|----------|-----|--------| +| [dsxksss](https://github.com/dsxksss) | 50 CNY | 十一 | 20 CNY | +| 沭飏秋 | 10 CNY | 朱东杰 | 60 CNY | +| 匿名 | 5 CNY | wu | 10 CNY | +| 云烨 | 2.76 CNY | | | diff --git a/res/screenshot/desktop.webp b/res/screenshot/desktop.webp deleted file mode 100644 index 023d142..0000000 Binary files a/res/screenshot/desktop.webp and /dev/null differ diff --git a/res/screenshot/desktop_dark.webp b/res/screenshot/desktop_dark.webp new file mode 100644 index 0000000..25e79eb Binary files /dev/null and b/res/screenshot/desktop_dark.webp differ diff --git a/res/screenshot/desktop_light.webp b/res/screenshot/desktop_light.webp new file mode 100644 index 0000000..fa6e124 Binary files /dev/null and b/res/screenshot/desktop_light.webp differ diff --git a/res/screenshot/mobile.webp b/res/screenshot/mobile.webp deleted file mode 100644 index 4f097e5..0000000 Binary files a/res/screenshot/mobile.webp and /dev/null differ diff --git a/res/screenshot/mobile_dark.webp b/res/screenshot/mobile_dark.webp new file mode 100644 index 0000000..84de03b Binary files /dev/null and b/res/screenshot/mobile_dark.webp differ diff --git a/res/screenshot/mobile_light.webp b/res/screenshot/mobile_light.webp new file mode 100644 index 0000000..0bbd2ad Binary files /dev/null and b/res/screenshot/mobile_light.webp differ