Add README.md with project documentation
This commit is contained in:
89
README.md
Normal file
89
README.md
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
# ASKI Portal App
|
||||||
|
|
||||||
|
Eine Solar2D/Corona SDK Mobile App für das ASKI Portal.
|
||||||
|
|
||||||
|
## 📱 Plattformen
|
||||||
|
|
||||||
|
- iOS
|
||||||
|
- Android
|
||||||
|
|
||||||
|
## 🛠️ Technologie
|
||||||
|
|
||||||
|
- **Framework:** Solar2D (Corona SDK)
|
||||||
|
- **Sprache:** Lua
|
||||||
|
- **Ausrichtung:** Portrait
|
||||||
|
- **Auflösung:** 320x480 (skaliert)
|
||||||
|
|
||||||
|
## 📋 Voraussetzungen
|
||||||
|
|
||||||
|
- [Solar2D SDK](https://solar2d.com/) installiert
|
||||||
|
- Für iOS-Builds: macOS mit Xcode
|
||||||
|
- Für Android-Builds: Android Studio / SDK
|
||||||
|
|
||||||
|
## 🚀 Installation & Entwicklung
|
||||||
|
|
||||||
|
1. Repository klonen:
|
||||||
|
```bash
|
||||||
|
git clone https://gitea.joshihomeserver.ipv64.net/josiadmin/askiPortalSolar2D.git
|
||||||
|
cd askiPortalSolar2D
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Projekt in Solar2D Simulator öffnen:
|
||||||
|
- Solar2D Simulator starten
|
||||||
|
- Projektordner öffnen
|
||||||
|
- `main.lua` auswählen
|
||||||
|
|
||||||
|
3. App im Simulator testen
|
||||||
|
|
||||||
|
## 🔧 Konfiguration
|
||||||
|
|
||||||
|
### config.lua
|
||||||
|
- Bildschirmauflösung: 320x480
|
||||||
|
- Skalierungsmodus: Letterbox
|
||||||
|
- FPS: 60
|
||||||
|
|
||||||
|
### build.settings
|
||||||
|
- Standard-Ausrichtung: Portrait
|
||||||
|
- Android-Berechtigungen: Internet
|
||||||
|
- iOS Launch Screen: LaunchScreen.storyboardc
|
||||||
|
|
||||||
|
## 📦 Build
|
||||||
|
|
||||||
|
### Android
|
||||||
|
1. Im Solar2D Simulator: File → Build → Android
|
||||||
|
2. APK wird im angegebenen Ausgabeordner erstellt
|
||||||
|
|
||||||
|
### iOS
|
||||||
|
1. Im Solar2D Simulator: File → Build → iOS
|
||||||
|
2. App-Bundle für Xcode-Submission wird erstellt
|
||||||
|
|
||||||
|
## 🔐 Berechtigungen
|
||||||
|
|
||||||
|
### Android
|
||||||
|
- `android.permission.INTERNET` - Für Netzwerkzugriff
|
||||||
|
|
||||||
|
## 📁 Projektstruktur
|
||||||
|
|
||||||
|
```
|
||||||
|
├── main.lua # Haupteinstiegspunkt
|
||||||
|
├── config.lua # App-Konfiguration
|
||||||
|
├── build.settings # Build-Einstellungen
|
||||||
|
├── AndroidResources/ # Android-spezifische Ressourcen
|
||||||
|
│ └── res/ # Icons und Werte
|
||||||
|
├── Images.xcassets/ # iOS App Icons
|
||||||
|
└── LaunchScreen.storyboardc/ # iOS Launch Screen
|
||||||
|
```
|
||||||
|
|
||||||
|
## 👤 Autor
|
||||||
|
|
||||||
|
josiadmin
|
||||||
|
|
||||||
|
## 📄 Lizenz
|
||||||
|
|
||||||
|
[Lizenz hier einfügen]
|
||||||
|
|
||||||
|
## 🔗 Links
|
||||||
|
|
||||||
|
- [Solar2D Dokumentation](https://docs.solar2d.com/)
|
||||||
|
- [Corona SDK Migration Guide](https://docs.solar2d.com/)
|
||||||
|
- [Git Repository](https://gitea.joshihomeserver.ipv64.net/josiadmin/askiPortalSolar2D.git)
|
||||||
Reference in New Issue
Block a user