Read My README

Lire-mon-lecture

Un modèle de réadme bien rangé et poli pour vos projets!
Captures d'écran · Exigences · Architecture · Technologies · Licence

Read-My-ReadMe est un modèle de lecture simple et bien rangé largement basé sur le modèle le meilleur-readme .

Il est à l'origine adapté pour être utilisé dans des projets mobiles, mais il peut être facilement personnalisé pour s'adapter à d'autres cas d'utilisation différents.

Vous vous sentez toujours sans inspiration? Voici quelques échantillons qui utilisent ce style Readme avec certaines personnalisations:

• XPENSOR : un tracker de dépenses Android local
• LaunchPad : une application sur les événements spatiaux
• Gardien de but : une application du Qatar 2022

? ️ ui / ux? ️

Cette section consiste à détailler l'interface utilisateur / UX de votre projet, leurs thèmes et leurs animations.

Les animations et le contenu interactif de cette section doivent être placés à l'intérieur des readme-assets/gifs .

Animation 1	Animation 2	Animation 3	Animation 4

(retour en haut)

? Captures d'écran?

Ici, vous pouvez ajouter des captures d'écran de vos projets, référencer le système de conception utilisé (matériau / cupertino / coutume) et les différents modes d'interface utilisateur (nuit / sombre).

Les captures d'écran de cette section doivent être placées à l'intérieur de readme-assets/images

Écran 1	Écran 2	Écran 3

Écran 4	Écran 5	Écran 6

(retour en haut)

Exigences

Ici, vous pouvez donner des instructions sur la façon de configurer votre projet localement: installation, touches API, etc.

1. Obtenez une clé API gratuite sur https://example.com
2. Cloner le repo

git clone https://github.com/your_username_/Project-Name.git 

3. Installez les packages NPM

npm install

Entrez votre API dans config.js

 const API_KEY = 'ENTER YOUR API' ;

(retour en haut)

? Architecture ?

Cette section doit commenter l'architecture utilisée dans le projet.

(retour en haut)

? Technologies?

Cette section doit répertorier tous les principaux frameworks / bibliothèques utilisés pour bootstrap votre projet.

(retour en haut)

? Auteur (s)?

Votre nom - @TWitter_Usernamme - [email protected]

Remarque: s'il y a beaucoup de contributeurs, vous pourriez envisager d'utiliser:

• Liste des contributeurs
• contribution

(retour en haut)

Licence

 MIT License

Copyright (c) 2023 Jonathan Areas

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

(retour en haut)