search

kamelNaroun / python.lycee

tutoriel Python pour l'enseignement de l'algorithmique au lycée
python.lycee.free.fr
2 stars 1 forks source link

Il manque un README #32

Closed kamelNaroun closed 12 years ago

kamelNaroun commented 12 years ago

Qu'est ce qu'on y met ?

Une présentation du tuto, un lien vers le blog, quelques mots sur le fait que le tuto est généré avec sphinx et que si d'autres veulent participer à notre projet, il ne faut pas hésiter.

What else ?

Grahack commented 12 years ago

Oui, avec une version en anglais très concise d'abord, expliquant que c'est un projet fr seulement.

--- En date de : Mar 30.8.11, kamelNaroun reply@reply.github.com a écrit :

De: kamelNaroun reply@reply.github.com Objet: [python.lycee] Il manque un README (#32) À: christophegragnic@yahoo.fr Date: Mardi 30 août 2011, 23h44 Qu'est ce qu'on y met ?

Une présentation du tuto, un lien vers le blog, quelques mots sur le fait que le tuto est généré avec sphinx et que si d'autres veulent participer à notre projet, il ne faut pas hésiter.

What else ?

Reply to this email directly or view it on GitHub: https://github.com/kamelNaroun/python.lycee/issues/32

kamelNaroun commented 12 years ago

Je vais essayer de faire ça.

kamelNaroun commented 12 years ago

Euh ... qu'estce que je mets comme titre de fichier pour la version anglaise ?

Grahack commented 12 years ago

Je n'ai pas trop compris la question. Peut-être que c'est une blague sur le fait que README soit déjà en anglais. Sinon va voir les autres dépôts, un README sert de page de présentation, on peut mettre du formatage GFM du coup pour faire joli.

chri

kamelNaroun commented 12 years ago

Non, pas de blague. Ce que je voulais dire c'est quel nom choisir pour le fichier : est-ce que README-en.rst convient par exemple ? Je ne connais pas l'usage s'il y en a un.

Quant au formatage GFM, je ne sais pas du tout ce que c'est. Mais en rst, c'est suffisant, non ?

Grahack commented 12 years ago

GFM http://github.github.com/github-flavored-markdown/

Readme http://help.github.com/create-a-repo/ Y à un petit paragraphe 'more about readmds'

kamelNaroun commented 12 years ago

J'ai vu pour le GFM, mais je crois que je vais m'en tenir au rst pour l'instant.

J'ai aussi regardé le 'more about readmes' mais ça ne répondait pas à ma question. Alors ce n'est pas grave. Je fais une proposition que tu pourras modifier si tu le souhaites.

Grahack commented 12 years ago

Tu l’appelles juste README, tu ne mets pas de format particulier (ni GFM ni reST) et ça ira très bien. L’idée c’est que ça sert aussi de page de garde au projet sur github, en plus de présenter le machin à ceux qui tombent sur les sources pour la première fois.

kamelNaroun commented 12 years ago

Ok, c'est fait.