openfab-lab / openfab

Main repo for the wiki and project management

Creative Commons Attribution Share Alike 4.0 International

10 stars 10 forks source link

Rédaction du fichier read.me du repo OpenFab #87

Closed Ginsburg closed 7 years ago

Ginsburg commented 7 years ago

Rédaction du fichier read.me du repo OpenFab

ref to file.md or #issue : https://github.com/openfab-lab/openfab/blob/master/README.md

contexte

C'est le premier fichier sur lequel arrive un visiteur.

objectif

Avoir un read.me qui claque, simple et efficace pour guider les visiteurs, contributeurs, membres, ...

proposition

Template: _what _how _why _help

ressources

Guide Open Source : https://opensource.guide/starting-a-project/#writing-a-readme Template: _What does this project do? _Why is this project useful? _How do I get started? _Where can I get more help, if I need it?

Resultats

rewards

nicolasdb commented 7 years ago

Je pense aussi qu'une table des matières serrait pertinante quelque part dans le readme. Je ne retrouve pas facilement ce que j'ai déplacé :p

nicolasdb commented 7 years ago

Quote du docu COSMOS " One adventure, many heroes"

J'aime bien cette idée pour le readme.

Sent from my LGE Nexus 5 using FastHub

nicolasdb commented 7 years ago

You're welcome rug-funny-doormats

Ginsburg commented 7 years ago

Voili voilou, j'ai assez envie de faire cette issue dans pas trop longtemps pour dire que ça cloture la première itération dans l'idée dans refaire une nouvelle quand on aura envie de l'améliorer.

En anglais, sûrement avec plein de fautes. En français, sûrement avec un peu de fautes mais pas trop.

Y-a-t'il des modifs à faire avant fermeture ?

nicolasdb commented 7 years ago

@openfab-lab/website-modo

nicolasdb commented 7 years ago

C'est top la timeline. :) Il y a des trucs qui passent pas par contre. comme les termes USER dans un titre FR, ça cloche. idem avec METAUSER. ça se lit bisarement dans le titre. Mais faut quelqu'un de plus litéraire et graphiste pour affiner la com. c'est sur.

Ginsburg commented 7 years ago

Effectivement, j'ai tellement en tête le mot anglais que j'en oublie que ça peut être un mot français qui n'a pas franchement la même signification !

Je sais pas trop si la timeline est à sa place ici mais je me disais que pouvoir communiquer facilement ce parcours membre, cette possibilité d'évolution pouvait servir de fil conducteur pour introduire la gamification aux membres potentiels comme à ceux déjà présents.

nicolasdb commented 7 years ago

Done. ET pull request fusionné.

+6crrr à @Ginsburg