BeyondCodeBootcamp / BeyondCodeBootcamp/beyondcodebootcamp
Great README examples (documentation, markdown)
- Langage dominant
- JavaScript
- Étoiles
- 63
- Forks
- 3
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
# What should a README be?
Projects should have READMEs that have
- Easy to understand the purpose
- At-a-glance visual usage / demo
- Actual demo
- Easy deploy instructions
# Great READMEs
- [Print-to-PDF HTML Resume](https://github.com/BeyondCodeBootcamp/html-resume)
- [Markdown Slides](https://github.com/dadoomer/markdown-slides)
- [XTZ.js](https://github.com/therootcompany/tz.js)
- [mssql-to-csv](https://github.com/therootcompany/mssql-to-csv)
- [README Template](https://github.com/othneildrew/Best-README-Template)
# Master Markdown
(honestly, it's easy)
- https://github.com/BeyondCodeBootcamp/beyondcodebootcamp/issues/2#markdown
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Commencez par examiner le README actuel du dépôt en le comparant aux exemples liés dans l’issue. L’issue ne précise aucun fichier cible, aucune modification particulière ni aucun critère d’acceptation ; définissez donc le périmètre du README et une liste de contrôle mesurable de fin avant de commencer.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- markdown
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100