Skip to content
This repository was archived by the owner on Sep 17, 2025. It is now read-only.

Commit 4bc1caf

Browse files
committed
Update README.md, README.zh.md and README.tr.md
1 parent f70a33b commit 4bc1caf

3 files changed

Lines changed: 42 additions & 30 deletions

File tree

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ OpenNote is a modern Android note-taking application built entirely with Compose
1717
[<img alt="Get it on IzzyOnDroid" src="screenshots/izzyondroid.png" width="200px">](https://apt.izzysoft.de/fdroid/index/apk/com.yangdai.opennote)
1818
[<img alt="Get it on GitHub" src="screenshots/github.png" width="200px">](https://github.com/YangDai2003/OpenNote-Compose/releases)
1919

20-
## Features
20+
## 📃 Features
2121

2222
### Core Features:
2323
- **Create, Edit, and Delete Notes:** Users can easily create, modify, and remove notes.
@@ -46,7 +46,7 @@ OpenNote is a modern Android note-taking application built entirely with Compose
4646
- **Comprehensive Mouse and Keyboard Support:** The app has been thoroughly adapted for seamless interaction with mice and external physical keyboards, delivering a highly productive environment.
4747
- **Responsive Design:** Optimized for various screen sizes and device orientations, ensuring a great experience on phones, tablets, foldables and even ChromeOS devices.
4848

49-
## Screenshots
49+
## 🖼️ Screenshots
5050

5151
<div style="overflow-x: auto; white-space: nowrap;">
5252

@@ -68,12 +68,16 @@ OpenNote is a modern Android note-taking application built entirely with Compose
6868

6969
</div>
7070

71-
## How to Use OpenNote with Markdown, LaTeX Math, and Mermaid Diagrams?
71+
## 🌎 Translations
72+
73+
Currently supports Chinese, English, German and Turkish.
74+
75+
## 💡 How to Use OpenNote with Markdown, LaTeX Math, and Mermaid Diagrams?
7276

7377
You can know more about how to use OpenNote with Markdown, LaTeX Math, and Mermaid Diagrams in
7478
the [Guide](Guide.md).
7579

76-
## Technical Details
80+
## 🔎 Technical Details
7781

7882
- **Programming Languages**: Kotlin
7983
- **Build Tool**: Gradle with Kotlin DSL
@@ -82,14 +86,14 @@ the [Guide](Guide.md).
8286
- **Kotlin Version**: The application uses Kotlin version 2.1.10.
8387
- **Java Version**: The application uses Java version 17.
8488

85-
## Architecture
89+
## 🛠️ Architecture
8690

8791
- **MVVM (Model-View-ViewModel)**: Separates the user interface logic from the business logic,
8892
providing a clear separation of concerns.
8993
- **Clean Architecture**: Emphasizes separation of concerns and layers of abstraction, making the
9094
application more modular, scalable, and maintainable.
9195

92-
## Libraries and Frameworks
96+
## 📚 Libraries and Frameworks
9397

9498
- **Compose**: A modern toolkit for building native Android UI.
9599
- **Hilt**: A dependency injection library for Android.
@@ -100,11 +104,11 @@ the [Guide](Guide.md).
100104
- **Material Icons**: Provides Material Design icons for consistent visual elements.
101105
- **CommonMark**: For markdown parsing and rendering.
102106

103-
## Privacy Policy and Required Permissions
107+
## 🔐 Privacy Policy and Required Permissions
104108

105109
You can find the Privacy Policy and Required Permissions in the [Privacy Policy](PRIVACY_POLICY.md).
106110

107-
## Installation
111+
## 📦 Installation
108112

109113
To build and run this application, you need to install the latest version of Android Studio. Then,
110114
you can clone this repository from GitHub and open it in Android Studio.
@@ -115,12 +119,12 @@ git clone https://github.com/YangDai2003/OpenNote.git
115119

116120
In Android Studio, select `Run > Run 'app'` to start the application.
117121

118-
## Contribution
122+
## 🎈 Contribution
119123

120124
Any form of contribution is welcome! If you find a bug or have a new feature request, please create
121125
an issue. If you want to contribute code directly to this project, you can create a pull request.
122126

123-
## References
127+
## 🔗 References
124128

125129
- [MaskAnim](https://github.com/setruth/MaskAnim): Implementation of the theme switching function
126130
using mask animation.

README.tr.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ OpenNote, tamamen Jetpack Compose kullanılarak geliştirilmiş modern bir Andro
1717
[<img alt="Get it on IzzyOnDroid" src="screenshots/izzyondroid.png" width="200px">](https://apt.izzysoft.de/fdroid/index/apk/com.yangdai.opennote)
1818
[<img alt="Get it on GitHub" src="screenshots/github.png" width="200px">](https://github.com/YangDai2003/OpenNote-Compose/releases)
1919

20-
## Özellikler
20+
## 📃 Özellikler
2121

2222
### Temel Özellikler:
2323
- **Not Oluşturma, Düzenleme ve Silme:** Kullanıcılar kolayca not oluşturabilir, düzenleyebilir ve silebilir.
@@ -46,7 +46,7 @@ OpenNote, tamamen Jetpack Compose kullanılarak geliştirilmiş modern bir Andro
4646
- **Fare ve Klavye Desteği:** Harici fare ve klavyelerle eksiksiz bir uyumluluk sunarak üretkenliği artırır.
4747
- **Duyarlı Tasarım:** Telefonlar, tabletler, katlanabilir cihazlar ve ChromeOS cihazları için optimize edilmiştir.
4848

49-
## Ekran Görüntüleri
49+
## 🖼️ Ekran Görüntüleri
5050

5151
<div style="overflow-x: auto; white-space: nowrap;">
5252

@@ -68,25 +68,29 @@ OpenNote, tamamen Jetpack Compose kullanılarak geliştirilmiş modern bir Andro
6868

6969
</div>
7070

71-
## OpenNote'u Markdown, LaTeX Matematik ve Mermaid Diyagramları ile Kullanma
71+
## 🌎 Çeviriler
72+
73+
Şu anda Çince, İngilizce, Almanca ve Türkçe'yi destekliyor.
74+
75+
## 💡 OpenNote'u Markdown, LaTeX Matematik ve Mermaid Diyagramları ile Kullanma
7276

7377
OpenNote'un Markdown, LaTeX Matematik ve Mermaid Diyagramları ile nasıl kullanılacağını öğrenmek için
7478
[Rehber](Guide.md) dosyasına göz atabilirsiniz.
7579

76-
## Teknik Detaylar
80+
## 🔎 Teknik Detaylar
7781

7882
- **Programlama Dili**: Kotlin
7983
- **Derleme Aracı**: Gradle (Kotlin DSL)
8084
- **Android Sürümü**: Uygulama Android SDK 35 sürümünü hedefler ve Android SDK 29 ve üzeri cihazlarla uyumludur.
8185
- **Kotlin Sürümü**: 2.1.10
8286
- **Java Sürümü**: Java 17
8387

84-
## Mimari
88+
## 🛠️ Mimari
8589

8690
- **MVVM (Model-View-ViewModel)**: Kullanıcı arayüzü mantığını iş mantığından ayırarak net bir yapı sunar.
8791
- **Temiz Mimari (Clean Architecture)**: Modüler, ölçeklenebilir ve sürdürülebilir bir yapı için katmanlı bir ayrım uygular.
8892

89-
## Kütüphaneler ve Çatılar
93+
## 📚 Kütüphaneler ve Çatılar
9094

9195
- **Compose**: Modern, yerel Android kullanıcı arayüzleri oluşturmak için kullanılan bir araç takımı.
9296
- **Hilt**: Android için bağımlılık enjeksiyonu sağlayan bir kütüphane.
@@ -96,12 +100,12 @@ OpenNote'un Markdown, LaTeX Matematik ve Mermaid Diyagramları ile nasıl kullan
96100
- **Material Icons**: Tutarlı görseller için Material Design simgelerini içerir.
97101
- **CommonMark**: Markdown ayrıştırma ve işleme için.
98102

99-
## Gizlilik Politikası ve Gerekli İzinler
103+
## 🔐 Gizlilik Politikası ve Gerekli İzinler
100104

101105
Gizlilik Politikası ve uygulamanın ihtiyaç duyduğu izinler hakkında bilgi almak için
102106
[Gizlilik Politikası](PRIVACY_POLICY.md) sayfasına göz atabilirsiniz.
103107

104-
## Kurulum
108+
## 📦 Kurulum
105109

106110
Bu uygulamayı derleyip çalıştırmak için en güncel Android Studio sürümünü yüklemeniz gerekir.
107111
Daha sonra GitHub üzerindeki bu projeyi klonlayarak Android Studio'da açabilirsiniz.
@@ -112,13 +116,13 @@ git clone https://github.com/YangDai2003/OpenNote.git
112116

113117
Android Studio'da, uygulamayı başlatmak için Çalıştır > 'app' Çalıştır seçeneğini seçin.
114118

115-
## Katkı
119+
## 🎈 Katkı
116120

117121
Her türlü katkıya açığız! Eğer bir hata bulursanız veya yeni bir özellik talebiniz varsa, lütfen bir
118122
issue oluşturun. Bu projeye doğrudan kod katkısında bulunmak istiyorsanız, bir pull request
119123
oluşturabilirsiniz.
120124

121-
## Referanslar
125+
## 🔗 Referanslar
122126

123127
- [MaskAnim](https://github.com/setruth/MaskAnim): Tema değiştirme işlevinin maske animasyonu
124128
kullanılarak uygulanması.

README.zh.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ OpenNote是一款完全使用Compose构建的现代化Android记事本应用程
1717
[<img alt="Get it on IzzyOnDroid" src="screenshots/izzyondroid.png" width="200px">](https://apt.izzysoft.de/fdroid/index/apk/com.yangdai.opennote)
1818
[<img alt="Get it on GitHub" src="screenshots/github.png" width="200px">](https://github.com/YangDai2003/OpenNote-Compose/releases)
1919

20-
## 功能
20+
## 📃 功能
2121

2222
### 核心功能
2323
- **创建、编辑和删除笔记**:用户可以轻松创建、编辑和删除笔记。
@@ -46,7 +46,7 @@ OpenNote是一款完全使用Compose构建的现代化Android记事本应用程
4646
- **支持鼠标和物理键盘**:应用对使用鼠标和外接物理键盘时的操作做了充足的适配,确保了高生产力表现。
4747
- **响应式设计**:针对不同屏幕尺寸和方向的设备进行了优化,在手机、平板、折叠屏甚至搭载了ChromeOS的设备上都具有良好的体验。
4848

49-
## 屏幕截图
49+
## 🖼️ 屏幕截图
5050

5151
<div style="overflow-x: auto; white-space: nowrap;">
5252

@@ -68,25 +68,29 @@ OpenNote是一款完全使用Compose构建的现代化Android记事本应用程
6868

6969
</div>
7070

71-
## 如何使用 Markdown, LaTeX Math 和 Mermaid 图表的语法在 OpenNote 中编写文档?
71+
## 🌎 翻译
72+
73+
目前支持中文、英文、德语和土耳其语。
74+
75+
## 💡 如何使用 Markdown, LaTeX Math 和 Mermaid 图表的语法在 OpenNote 中编写文档?
7276

7377
您可以在[指南](Guide.zh.md)中了解有关如何使用 Markdown,LaTeX Math 和 Mermaid 图表的语法在 OpenNote
7478
中编写文档的更多信息。
7579

76-
## 技术细节
80+
## 🔎 技术细节
7781

7882
- **编程语言**:Kotlin
7983
- **构建工具**:Gradle和Kotlin DSL
8084
- **Android版本**:应用程序目标为Android SDK版本35,并且与运行Android SDK版本29及以上的设备兼容。
8185
- **Kotlin版本**:应用程序使用Kotlin版本2.1.10。
8286
- **Java版本**:应用程序使用Java版本17。
8387

84-
## 架构
88+
## 🛠️ 架构
8589

8690
- **MVVM(模型-视图-视图模型)**:将用户界面逻辑与业务逻辑分开,提供清晰的关注点分离。
8791
- **干净架构**:强调关注点和抽象层的分离,使应用程序更加模块化、可扩展和可维护。
8892

89-
## 库和框架
93+
## 📚 库和框架
9094

9195
- **Compose**:用于构建本机 Android UI 的现代化工具包。
9296
- **Hilt**:Android 的依赖注入库。
@@ -96,11 +100,11 @@ OpenNote是一款完全使用Compose构建的现代化Android记事本应用程
96100
- **Material Icons**:提供材质设计图标以实现一致的视觉元素。
97101
- **CommonMark**: 用于 Markdown 解析和渲染。
98102

99-
## 隐私政策和所需权限
103+
## 🔐 隐私政策和所需权限
100104

101105
您可以在[隐私政策](PRIVACY_POLICY.md)中找到隐私政策和所需权限。
102106

103-
## 安装
107+
## 📦 安装
104108

105109
要构建和运行此应用程序,您需要安装最新版本的Android Studio。然后,您可以从GitHub克隆此仓库并在Android
106110
Studio中打开它。
@@ -111,10 +115,10 @@ git clone https://github.com/YangDai2003/OpenNote.git
111115

112116
在Android Studio中,选择`Run > Run 'app'`来启动应用程序。
113117

114-
## 贡献
118+
## 🎈 贡献
115119

116120
欢迎任何形式的贡献!如果您发现错误或有新的功能请求,请创建问题。如果您想直接向此项目贡献代码,您可以创建拉取请求。
117121

118-
## 参考
122+
## 🔗 参考
119123

120124
- [MaskAnim](https://github.com/setruth/MaskAnim):用于使用遮罩动画来切换主题功能的实现。

0 commit comments

Comments
 (0)