Skip to content

README files/fr

Importance des fichiers README

Dans vos espaces /project, vos données doivent être documentées pour bien décrire l'utilité de chaque fichier. Un fichier README est généralement la première référence.

L'utilisation de fichiers README sur nos grappes fait partie de la gestion active des données de recherche. Ils seront utiles pour les publications futures et pour que les membres de l'équipe sachent à quoi correspondent les fichiers contenus dans un répertoire.

Contenu d'un fichier README

  • Source des fichiers
    • Site web ou base de données externe
    • Auteurs
    • Année
  • Types de fichiers présents dans le répertoire
    • Structure des répertoires
  • Quels fichiers sont temporaires
  • Quels fichiers sont activement utilisés
  • Quels fichiers sont archivés
  • Qui doit avoir accès à quoi et quand :
    • Sur la grappe
    • Sur un référentiel de données (dans le futur)

Formats des fichiers README

  • README ou README.txt
    • format texte libre
    • mieux que rien, mais aucun style conventionnel n'est imposé
  • README.md (Markdown), README.rst (reStructuredText)
    • format de texte structuré lisible par l'utilisateur
    • peut être compilé en texte formaté (HTML ou PDF).
  • README.yaml (YAML), README.json (JSON), README.xml (XML)
    • légèrement moins lisible par l'utilisateur
    • lisible par machine, ce qui signifie qu'un programme peut valider le contenu du fichier README.
    • peut être utilisé pour générer un fichier README dans un autre format

Références