Add a Readme file

This commit is contained in:
Jacques Foucry 2022-01-01 19:57:24 +01:00
parent 29f4fc70ce
commit 608f9b4655

87
README.md Normal file
View file

@ -0,0 +1,87 @@
# Pilldroid
Pilldroid est une application de gestion de stock **théorique** de médicament à
destinations des personnes résidant en France.
## Ce que n'est pas PillDroid
- Pilldroid n'est pas un pilulier. Pilldroid ne vous rappellera pas de prendre
vos médicaments, c'est **VOTRE** responsabilité ;
- Pilldroid n'est pas fiable, ce n'est qu'une aide. Seul votre stock réel est bon
;
- Pilldroid ne vous surveille pas.
## Pourquoi « Stock théorique » ?
Pilldroid ne sait (et n'a aucun moyen de savoir) si vous avez ou non pris vos
médicaments. Pilldroid effectue, simple calcul : `stock connus - prise par
jour`. Ce calcul est fait tous les jours entre 11h et midi.
## De quelles autorisations l'application Pilldroid a-t-elle besoin ?
- Pilldroid à besoin de savoir que le téléphone a été redémarré pour elle-même
lancer son cycle de réveil journalier ;
- Pilldroid a besoin d'accéder à l'appareil photo de votre téléphone pour
scanner le code barre des boites de médicaments ;
- Pilldroid a besoin de pouvoir vous envoyer des alarmes ;
- Pilldroid a besoin de faire vibrer le téléphone pour les alarmes.
## L'application Pilldroid embarque-t-elle des bibliothèques tierce ?
Oui. Pour la lecture de code barre, Pilldroid utilise le projet
[zxing](https://github.com/journeyapps/zxing-android-embedded) lui-même libre et
ouvert.
A terme Pilldroid utilisera la bibliothèque
[sentry.io](https://sentry.io/for/android/) quand j'aurais compris comment cela
fonctionne. Le but est d'avoir des remontées les crashs de l'application sans
collecter de données à caractère personnel.
Déjà embarquée mais non fonctionnelle, `sentry.io` à besoin de l'accès Internet.
## L'application Pilldroid contient-elle des pisteurs ?
NON !
```
Requested API level 30 is larger than maximum we have, returning API level 28 instead.
=== Information
- APK path: /home/jacques/StudioProjects/PillDroid/app/build/outputs/apk/preproduct/prerelease/app-preproduct-prerelease.apk
- APK sum: ba0bafbd8da39507d62658cd666b2e9881002463bf8897ccb9f20b6ee93d2ed8
- App version: 0.65.20220101-d04e132
- App version code: 24065
- App UID: 66F9DAB6FD8F5957BA842BE9EE45FE923AE300DE
- App name: PillDroid Pre-Release
- App package: net.foucry.pilldroid
- App permissions: 5
- android.permission.VIBRATE
- android.permission.RECEIVE_BOOT_COMPLETED
- android.permission.INTERNET
- com.android.alarm.permission.SET_ALARM
- android.permission.CAMERA
- App libraries:
- Certificates: 0
=== Found trackers: 0
```
## D'où viennent les données de Pilldroid ?
Elles sont issues de plusieurs fichiers de l'Agence pour la Sécurité des
Médicaments, agrégés dans une base de données grâce à script Python qui sera
prochainement mis sur mon compte `github`.
## Comment peut-on participer à Pilldroid ?
Mon code est de piètre qualité et mes connaissances Java maigrelettes toute
amélioration **que je comprends** sera la bien venue (je n'ai pas pigé les
`lambda` par exemple).
Marché de niche, Pilldroid a besoin de testeuses et testeurs.
Prochainement, vous pourrez glisser quelques menues monnaies dans une tirelire
en ligne.
## L'application Pilldroid dispose telle d'un site web ?
Oui, [Pilldroid)(https://pildroid.foucry.net)