Ajouter 'README.md'

This commit is contained in:
ityt 2020-01-04 01:34:49 +01:00
parent 1f3f6d8d4e
commit 4eef7e1cac
1 changed files with 8 additions and 0 deletions

8
README.md Normal file
View File

@ -0,0 +1,8 @@
# userinput, gérer les entrées utilisateur.
## Bibliothèque pour le noyau [gint](https://gitea.planet-casio.com/Lephenixnoir/gint)
Cette bibliothèque a pour but de donner toutes les fontions nécessaires pour récupérer des données entrées par l'utilisateur d'une manière simple et sécurisée.
Pour l'instant, elle ne permet que de récupérer des nombres entiers positifs.
### Utilisation
Pour un projet gérer par le [fxsdk](https://gitea.planet-casio.com/Lephenixnoir/fxsdk), il faut tout simplement glisser les .c dans le dossier src/ et les .h dans le dossier include/. Ensuite écrire `#include "userinput.h"` dans le fichier où on veut utiliser les fonctions de la bibliothèque.
En théorie, il suffit de faire ceci `unsigned int a;
a = input_uint32();` et tout roule. L'utilisateur ne pourra pas dépasser les limites du type de la fonction.