Skip to content

Commit 6dba091

Browse files
committed
Unify and streamline documentation, changelogs, and app descriptions (DE/EN). Improved clarity, removed redundancies, and updated feature highlights for v1.7.0. [skip ci]
1 parent 5135c71 commit 6dba091

7 files changed

Lines changed: 195 additions & 256 deletions

File tree

.github/workflows/build-production-apk.yml

Lines changed: 30 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,62 +2,62 @@ name: Build Android Production APK
22

33
on:
44
push:
5-
branches: [ main ] # Nur bei Push/Merge auf main triggern
6-
workflow_dispatch: # Ermöglicht manuellen Trigger
5+
branches: [ main ] # Only trigger on push/merge to main
6+
workflow_dispatch: # Enables manual trigger
77

88
permissions:
9-
contents: write # Fuer Release-Erstellung erforderlich
9+
contents: write # Required for release creation
1010

1111
jobs:
1212
build:
1313
name: Build Production APK
1414
runs-on: ubuntu-latest
1515

1616
steps:
17-
- name: Code auschecken
17+
- name: Checkout code
1818
uses: actions/checkout@v4
1919

20-
- name: Java einrichten
20+
- name: Setup Java
2121
uses: actions/setup-java@v4
2222
with:
2323
distribution: 'temurin'
2424
java-version: '17'
2525

26-
- name: Semantic Versionsnummer aus build.gradle.kts extrahieren
26+
- name: Extract semantic version from build.gradle.kts
2727
run: |
28-
# Version aus build.gradle.kts fuer F-Droid Kompatibilität
28+
# Version from build.gradle.kts for F-Droid compatibility
2929
VERSION_NAME=$(grep "versionName = " android/app/build.gradle.kts | sed 's/.*versionName = "\(.*\)".*/\1/')
3030
VERSION_CODE=$(grep "versionCode = " android/app/build.gradle.kts | sed 's/.*versionCode = \([0-9]*\).*/\1/')
3131
32-
# Semantische Versionierung (nicht datums-basiert)
32+
# Semantic versioning (not date-based)
3333
BUILD_NUMBER="$VERSION_CODE"
3434
3535
echo "VERSION_NAME=$VERSION_NAME" >> $GITHUB_ENV
3636
echo "BUILD_NUMBER=$BUILD_NUMBER" >> $GITHUB_ENV
3737
echo "VERSION_TAG=v$VERSION_NAME" >> $GITHUB_ENV
3838
39-
echo "🚀 Baue Version: $VERSION_NAME (Code: $BUILD_NUMBER)"
39+
echo "🚀 Building version: $VERSION_NAME (Code: $BUILD_NUMBER)"
4040
41-
- name: Version aus build.gradle.kts verifizieren
41+
- name: Verify version from build.gradle.kts
4242
run: |
43-
echo "✅ Verwende Version aus build.gradle.kts:"
43+
echo "✅ Using version from build.gradle.kts:"
4444
grep -E "versionCode|versionName" android/app/build.gradle.kts
4545
46-
- name: Android Signing konfigurieren
46+
- name: Configure Android signing
4747
run: |
4848
echo "${{ secrets.KEYSTORE_BASE64 }}" | base64 -d > android/app/simple-notes-release.jks
4949
echo "storePassword=${{ secrets.KEYSTORE_PASSWORD }}" > android/key.properties
5050
echo "keyPassword=${{ secrets.KEY_PASSWORD }}" >> android/key.properties
5151
echo "keyAlias=${{ secrets.KEY_ALIAS }}" >> android/key.properties
5252
echo "storeFile=simple-notes-release.jks" >> android/key.properties
53-
echo "✅ Signing-Konfiguration erstellt"
53+
echo "✅ Signing configuration created"
5454
55-
- name: Produktions-APK bauen (Standard + F-Droid Flavors)
55+
- name: Build production APK (Standard + F-Droid Flavors)
5656
run: |
5757
cd android
5858
./gradlew assembleStandardRelease assembleFdroidRelease --no-daemon --stacktrace
5959
60-
- name: APK-Varianten mit Versionsnamen kopieren
60+
- name: Copy APK variants with version names
6161
run: |
6262
mkdir -p apk-output
6363
@@ -69,34 +69,34 @@ jobs:
6969
cp android/app/build/outputs/apk/fdroid/release/app-fdroid-release.apk \
7070
apk-output/simple-notes-sync-v${{ env.VERSION_NAME }}-fdroid.apk
7171
72-
echo "✅ APK-Dateien vorbereitet:"
72+
echo "✅ APK files prepared:"
7373
ls -lh apk-output/
7474
75-
- name: APK-Artefakte hochladen
75+
- name: Upload APK artifacts
7676
uses: actions/upload-artifact@v4
7777
with:
7878
name: simple-notes-sync-apks-v${{ env.VERSION_NAME }}
7979
path: apk-output/*.apk
80-
retention-days: 90 # Produktions-Builds länger aufbewahren
80+
retention-days: 90 # Keep production builds longer
8181

82-
- name: Commit-Informationen auslesen
82+
- name: Extract commit information
8383
run: |
8484
echo "SHORT_SHA=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
8585
echo "COMMIT_DATE=$(git log -1 --format=%cd --date=iso-strict)" >> $GITHUB_ENV
8686
87-
- name: F-Droid Changelogs lesen
87+
- name: Read F-Droid changelogs
8888
run: |
89-
# Lese deutsche Changelog (Hauptsprache) - Use printf to ensure proper formatting
89+
# Read German changelog (main language) - Use printf to ensure proper formatting
9090
if [ -f "fastlane/metadata/android/de-DE/changelogs/${{ env.BUILD_NUMBER }}.txt" ]; then
9191
CHANGELOG_CONTENT=$(cat "fastlane/metadata/android/de-DE/changelogs/${{ env.BUILD_NUMBER }}.txt")
9292
echo "CHANGELOG_DE<<GHADELIMITER" >> $GITHUB_ENV
9393
echo "$CHANGELOG_CONTENT" >> $GITHUB_ENV
9494
echo "GHADELIMITER" >> $GITHUB_ENV
9595
else
96-
echo "CHANGELOG_DE=Keine deutschen Release Notes verfügbar." >> $GITHUB_ENV
96+
echo "CHANGELOG_DE=No German release notes available." >> $GITHUB_ENV
9797
fi
9898
99-
# Lese englische Changelog (optional)
99+
# Read English changelog (optional)
100100
if [ -f "fastlane/metadata/android/en-US/changelogs/${{ env.BUILD_NUMBER }}.txt" ]; then
101101
CHANGELOG_CONTENT_EN=$(cat "fastlane/metadata/android/en-US/changelogs/${{ env.BUILD_NUMBER }}.txt")
102102
echo "CHANGELOG_EN<<GHADELIMITER" >> $GITHUB_ENV
@@ -127,25 +127,19 @@ jobs:
127127
128128
</details>
129129
130-
---
131-
132130
## 📦 Downloads
133131
134-
| Variante | Datei | Info |
135-
|----------|-------|------|
136-
| **🏆 Empfohlen** | `simple-notes-sync-v${{ env.VERSION_NAME }}-standard.apk` | Standard-Version (funktioniert auf allen Geraeten) |
137-
| F-Droid | `simple-notes-sync-v${{ env.VERSION_NAME }}-fdroid.apk` | Fuer F-Droid Store |
138-
139-
---
132+
| Variant | File | Info |
133+
|---------|------|------|
134+
| **🏆 Recommended** | `simple-notes-sync-v${{ env.VERSION_NAME }}-standard.apk` | Standard version (works on all devices) |
135+
| F-Droid | `simple-notes-sync-v${{ env.VERSION_NAME }}-fdroid.apk` | For F-Droid Store |
140136
141-
## 📊 Build-Info
137+
## 📊 Build Info
142138
143139
- **Version:** ${{ env.VERSION_NAME }} (Code: ${{ env.BUILD_NUMBER }})
144-
- **Datum:** ${{ env.COMMIT_DATE }}
140+
- **Date:** ${{ env.COMMIT_DATE }}
145141
- **Commit:** ${{ env.SHORT_SHA }}
146142
147-
---
148-
149143
## 🔐 APK Signature Verification
150144
151145
All APKs are signed with the official release certificate.
@@ -157,8 +151,6 @@ jobs:
157151
42:A1:C6:13:BB:C6:73:04:5A:F3:DC:81:91:BF:9C:B6:45:6E:E4:4C:7D:CE:40:C7:CF:B5:66:FA:CB:69:F1:6A
158152
```
159153
160-
---
161-
162-
**[📖 Dokumentation](https://github.com/inventory69/simple-notes-sync/blob/main/QUICKSTART.md)** · **[🐛 Issue melden](https://github.com/inventory69/simple-notes-sync/issues)**
154+
**[📖 Documentation](https://github.com/inventory69/simple-notes-sync/blob/main/QUICKSTART.md)** · **[🐛 Report Bug](https://github.com/inventory69/simple-notes-sync/issues)**
163155
env:
164156
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.de.md

Lines changed: 64 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,84 @@
11
<div align="center">
2+
<br />
3+
<img src="android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png" alt="Logo" />
4+
<br /><br />
5+
</div>
26

3-
# Simple Notes Sync
7+
<h1 align="center">Simple Notes Sync</h1>
48

5-
**Minimalistische Offline-Notizen mit Auto-Sync zu deinem eigenen Server**
9+
<h4 align="center">Minimalistische Offline-Notizen mit intelligentem Sync - Einfachheit trifft smarte Synchronisation.</h4>
610

7-
[![Android](https://img.shields.io/badge/Android-8.0%2B-3DDC84?style=for-the-badge&logo=android&logoColor=white)](https://www.android.com/)
8-
[![Kotlin](https://img.shields.io/badge/Kotlin-7F52FF?style=for-the-badge&logo=kotlin&logoColor=white)](https://kotlinlang.org/)
9-
![Jetpack Compose](https://img.shields.io/badge/Jetpack%20Compose-4285F4?style=for-the-badge&logo=jetpackcompose&logoColor=white)
10-
[![Material 3](https://img.shields.io/badge/Material_3-6750A4?style=for-the-badge&logo=material-design&logoColor=white)](https://m3.material.io/)
11-
[![License](https://img.shields.io/badge/License-MIT-F5C400?style=for-the-badge)](LICENSE)
11+
<div align="center">
12+
<a href="https://www.android.com/">
13+
<img src="https://img.shields.io/badge/Android-8.0%2B-3DDC84?style=for-the-badge&logo=android&logoColor=white" alt="Android" />
14+
</a>
15+
<a href="https://kotlinlang.org/">
16+
<img src="https://img.shields.io/badge/Kotlin-7F52FF?style=for-the-badge&logo=kotlin&logoColor=white" alt="Kotlin" />
17+
</a>
18+
<a href="https://developer.android.com/compose/">
19+
<img src="https://img.shields.io/badge/Jetpack%20Compose-4285F4?style=for-the-badge&logo=jetpackcompose&logoColor=white" alt="Jetpack Compose" />
20+
</a>
21+
<a href="https://m3.material.io/">
22+
<img src="https://img.shields.io/badge/Material_3-6750A4?style=for-the-badge&logo=material-design&logoColor=white" alt="Material 3" />
23+
</a>
24+
<a href="LICENSE">
25+
<img src="https://img.shields.io/badge/License-MIT-F5C400?style=for-the-badge" alt="License" />
26+
</a>
27+
</div>
1228

13-
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" alt="Get it on IzzyOnDroid" height="60">](https://apt.izzysoft.de/fdroid/index/apk/dev.dettmer.simplenotes)
14-
[<img src="https://raw.githubusercontent.com/ImranR98/Obtainium/main/assets/graphics/badge_obtainium.png" alt="Get it on Obtainium" height="60">](http://apps.obtainium.imranr.dev/redirect.html?r=obtainium://add/https://github.com/inventory69/simple-notes-sync)
15-
[<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="60">](https://f-droid.org/packages/dev.dettmer.simplenotes/)
29+
<p align="center">
30+
<a href="https://apt.izzysoft.de/fdroid/index/apk/dev.dettmer.simplenotes" style="display:inline-block;">
31+
<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" alt="Get it on IzzyOnDroid" height="80" style="vertical-align:middle; margin-right:10px;">
32+
</a>
33+
<a href="http://apps.obtainium.imranr.dev/redirect.html?r=obtainium://add/https://github.com/inventory69/simple-notes-sync" style="display:inline-block;">
34+
<img src="https://raw.githubusercontent.com/ImranR98/Obtainium/main/assets/graphics/badge_obtainium.png" alt="Get it on Obtainium" height="55" style="vertical-align:middle; margin-right:10px;">
35+
</a>
36+
<a href="https://f-droid.org/packages/dev.dettmer.simplenotes/" style="display:inline-block;">
37+
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="80" style="vertical-align:middle;">
38+
</a>
39+
</p>
40+
<div align="center">
41+
<strong>SHA-256 Hash des Signaturzertifikats:</strong><br /> 42:A1:C6:13:BB:C6:73:04:5A:F3:DC:81:91:BF:9C:B6:45:6E:E4:4C:7D:CE:40:C7:CF:B5:66:FA:CB:69:F1:6A
42+
</div>
1643

17-
[📱 APK Download](https://github.com/inventory69/simple-notes-sync/releases/latest) · [📖 Dokumentation](docs/DOCS.de.md) · [🚀 Quick Start](QUICKSTART.de.md)
44+
<div align="center">
1845

19-
**🌍** **Deutsch** · [English](README.md)
46+
<br />[📱 APK Download](https://github.com/inventory69/simple-notes-sync/releases/latest) · [📖 Dokumentation](docs/DOCS.de.md) · [🚀 Schnellstart](QUICKSTART.de.md)<br />
47+
**🌍** Deutsch · [English](README.md)
2048

2149
</div>
2250

23-
---
24-
2551
## 📱 Screenshots
2652

2753
<p align="center">
28-
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/1.png" width="250" alt="Sync-Status">
29-
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/2.png" width="250" alt="Notiz bearbeiten">
30-
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/3.png" width="250" alt="Checkliste bearbeiten">
31-
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/4.png" width="250" alt="Einstellungen">
32-
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/5.png" width="250" alt="Server-Einstellungen">
33-
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/7.png" width="250" alt="Sync-Einstellungen">
54+
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/1.png" width="250" alt="Sync status">
55+
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/2.png" width="250" alt="Edit note">
56+
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/3.png" width="250" alt="Edit checklist">
57+
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/4.png" width="250" alt="Settings">
58+
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/5.png" width="250" alt="Server settings">
59+
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/7.png" width="250" alt="Sync settings">
3460
</p>
3561

36-
---
37-
3862
<div align="center">
3963

40-
📝 Offline-first &nbsp;&nbsp; 🔄 Smart Sync &nbsp;&nbsp; 🔒 Self-hosted &nbsp;&nbsp; 🔋 Akkuschonend
64+
📝 Offline-first &nbsp;&nbsp; 🔄 Smart Sync &nbsp;&nbsp; 🔒 Self-hosted &nbsp;&nbsp; 🔋 Akkuschonend
4165

4266
</div>
4367

44-
---
45-
4668
## ✨ Highlights
4769

48-
-**NEU: Checklisten** - Tap-to-Check, Drag & Drop
49-
- 🌍 **NEU: Mehrsprachig** - Deutsch/Englisch mit Sprachauswahl
50-
- 📝 **Offline-First** - Funktioniert ohne Internet
51-
- 🔄 **Konfigurierbare Sync-Trigger** - onSave, onResume, WiFi-Verbindung, periodisch (15/30/60 Min), Boot
52-
- 🔒 **Self-Hosted** - Deine Daten bleiben bei dir (WebDAV)
53-
- 💾 **Lokales Backup** - Export/Import als JSON-Datei
54-
- 🖥️ **Desktop-Integration** - Markdown-Export für Obsidian, VS Code, Typora
55-
- 🔋 **Akkuschonend** - ~0.2% mit Defaults, bis zu ~1.0% mit Periodic Sync
56-
- 🎨 **Material Design 3** - Dark Mode & Dynamic Colors
70+
- 📝 **Offline-first** – Funktioniert ohne Internet
71+
- 📊 **Flexible Ansichten** – Listen- und Grid-Layout
72+
-**Checklisten** – Tap-to-Check, Drag & Drop
73+
- 🌍 **Mehrsprachig** – Deutsch/Englisch mit Sprachauswahl
74+
- 🔄 **Konfigurierbare Sync-Trigger** – onSave, onResume, WiFi, periodisch (15/30/60 Min), Boot
75+
- 🔒 **Self-hosted** – Deine Daten bleiben bei dir (WebDAV)
76+
- 💾 **Lokales Backup** – Export/Import als JSON-Datei (optional verschlüsselt)
77+
- 🖥️ **Desktop-Integration** – Markdown-Export für Obsidian, VS Code, Typora
78+
- 🔋 **Akkuschonend**~0.2% mit Defaults, bis zu ~1.0% mit Periodic Sync
79+
- 🎨 **Material Design 3** – Dynamischer Dark/Light Mode & Farben
5780

58-
➡️ **Vollständige Feature-Liste:** [FEATURES.de.md](docs/FEATURES.de.md)
59-
60-
---
81+
➡️ **Vollständige Feature-Liste:** [docs/FEATURES.de.md](docs/FEATURES.de.md)
6182

6283
## 🚀 Schnellstart
6384

@@ -78,17 +99,15 @@ docker compose up -d
7899
1. [APK herunterladen](https://github.com/inventory69/simple-notes-sync/releases/latest)
79100
2. Installieren & öffnen
80101
3. ⚙️ Einstellungen → Server konfigurieren:
81-
- **URL:** `http://DEINE-SERVER-IP:8080/` _(nur Base-URL!)_
82-
- **User:** `noteuser`
83-
- **Passwort:** _(aus .env)_
84-
- **WLAN:** _(dein Netzwerk-Name)_
102+
- **URL:** `http://DEINE-SERVER-IP:8080/` _(nur Base-URL!)_
103+
- **User:** `noteuser`
104+
- **Passwort:** _(aus .env)_
105+
- **WLAN:** _(dein Netzwerk-Name)_
85106
4. **Verbindung testen** → Auto-Sync aktivieren
86107
5. Fertig! 🎉
87108

88109
➡️ **Ausführliche Anleitung:** [QUICKSTART.de.md](QUICKSTART.de.md)
89110

90-
---
91-
92111
## 📚 Dokumentation
93112

94113
| Dokument | Inhalt |
@@ -103,30 +122,22 @@ docker compose up -d
103122
| **[UPCOMING.de.md](docs/UPCOMING.de.md)** | Geplante Features 🚀 |
104123
| **[ÜBERSETZEN.md](docs/TRANSLATING.de.md)** | Übersetzungsanleitung 🌍 |
105124

106-
---
107-
108125
## 🛠️ Entwicklung
109126

110127
```bash
111128
cd android
112129
./gradlew assembleStandardRelease
113130
```
114131

115-
➡️ **Build-Anleitung:** [DOCS.md](docs/DOCS.md#-build--deployment)
116-
117-
---
132+
➡️ **Build-Anleitung:** [docs/DOCS.de.md#-build--deployment](docs/DOCS.de.md#-build--deployment)
118133

119134
## 🤝 Contributing
120135

121136
Beiträge willkommen! Siehe [CONTRIBUTING.md](CONTRIBUTING.md)
122137

123-
---
124-
125138
## 📄 Lizenz
126139

127-
MIT License - siehe [LICENSE](LICENSE)
128-
129-
---
140+
MIT License – siehe [LICENSE](LICENSE)
130141

131142
<div align="center">
132143

0 commit comments

Comments
 (0)