diff --git a/README.md b/README.md index 06f4cc7..274732f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # smoke_cess_app -A Flutter app to track the progress of smoking cessation. +Eine Flutter App, um Teilnehmer einer Studie des [ZI-Mannheim](https://www.zi-mannheim.de/index.html) zur Rauchentwöhnung bei der Durchführung der Studie zu unterstützen, die entstandenen Daten zu speichern und zugänglich zu machen. + +## Dependencies installieren + +Vor App-Start: +flutter pub get + +## App starten + +Die App lässt sich als Android- und iOS App ausführen und zu Debugzwecken ebenfalls als Webapp. + +## App bedienen + +Um die App nutzen zu können, müssen Settings eingelesen werden. Dazu kann entweder ein in die App integrierter QR-Code Scanner (mit dem beigefügten [QR-Code](./gruppe1_QR.png)) benutzt werden, oder zu Debugzwecken mit dem dafür vorgesehenen Button auf der Scannerseite über eine lokale JSON-Datei. diff --git a/gruppe1_QR.png b/gruppe1_QR.png new file mode 100644 index 0000000..f3e0e94 Binary files /dev/null and b/gruppe1_QR.png differ