La forme du rendu

La forme du rendu

by Benjamin Michel Eddy Schmid -
Number of replies: 10

Bonjour,

À quelques jours du rendu, je me pose la question si les extensions et les noms des fichiers doivent être respectés strictement ou si nous pouvons prendre quelques libertés par exemple utiliser d'autres extensions de fichiers (.md) avoir une organisation différente mais avec les mêmes éléments présents, ces différences étant expliquées dans le readme ?

Aussi nous nous demandons comment faciliter l'utilisation des différentes toupies et intégrateurs pour les assitants ?

Bonne journée.

In reply to Benjamin Michel Eddy Schmid

Re: La forme du rendu

by Josué Antoine Maechling -

Si vous voulez être sûrs que tout se passe pour le mieux, respectez les consignes. En tant qu'assistant si on doit corriger de nombreux projets d'affilée, ça peut devenir embêtant si tous sont organisés différemment déjà pour les fichiers explicatifs.

Après je comprends évidemment la volonté de vouloir fournir des documents plus "jolis". Je ne serais personnellement pas contre mais il faut que ce soit très bien expliqué, et surtout que vos fichiers soient dans un format libre.

Si il y a des documents rédigés en Microsoft Word ça pourrait mettre les assistants de mauvaise humeur pour la correction du reste du projet ;) (donc à ceux qui lisent et qui l'ont utilisé changez ça !)

Ensuite pour faciliter l'utilisation vous pouvez expliquer comment faire dans le readme ou faire un tuto à part si c'est vraiment très compliqué.  Ou vous pouvez tourner une vidéo et la mettre sur youtube et nous fournir le lien ça m'est égal.

Sinon vous pouvez faire une interface graphique pour l'initialisation des toupies (plus compliqué et chronophage pour vous attention).

DISCLAIMER : Je ne suis pas le prof je ne peux pas parler en son nom, et c'est à lui que reviendra le dernier mot sur ça.

In reply to Josué Antoine Maechling

Re: La forme du rendu

by Deleted user -
Et j'en profite aussi pour noter, histoire d'être explicite, que le markdown (.md) étant un format libre, ça conviendrait pour le rendu.

Après, question de bon sens, si votre fichier md est bourré de commandes syntaxiques qui rendent le texte impossible à déchiffrer, pensez au moins à fournir une version formatée du md (par exemple en html) qu'on puisse lire.
In reply to Deleted user

Re: La forme du rendu

by Benjamin Michel Eddy Schmid -

Merci pour cette réponse, une dernière question. Les commentaires doivent être en français ou on peut commenter en anglais ?

In reply to Benjamin Michel Eddy Schmid

Re: La forme du rendu

by Josué Antoine Maechling -
anglais ou français ça m'est complètement égal, si tu as le choix je dirais français mais normalement tous les assistants parlent anglais
In reply to Josué Antoine Maechling

Re: La forme du rendu

by Jean-Cédric Chappelier -

je confirme ce qui a été dit :

  • des formats ouverts (pas de format propriétaire fermé)
  • français ou anglais
In reply to Jean-Cédric Chappelier

Re: La forme du rendu

by Augustin Jean Robert Pelletier -

Bonjour,

Est-ce que un fichier .sh, en Unix, est un format propriétaire fermé? J'ai fait quelques recherches mais je n'ai trouvé l'information nulle part.

Si besoin, dans le README peut-on indiquer d'exécuter des commandes comme chmod ou une courte liste de commande (celles que l'on voudrait mettre dans le .sh) ?

Merci

In reply to Augustin Jean Robert Pelletier

Re: La forme du rendu

by Jean-Cédric Chappelier -

non, mais pourquoi donner un Shell script ??
Et non, merci, ne faites pas de votre README un tuto Unix, qui, par ailleurs, existe déjà dans le cours :

https://progmaph.epfl.ch/miniref/miniref-unixcmd.html ;-)

In reply to Jean-Cédric Chappelier

Re: La forme du rendu

by Augustin Jean Robert Pelletier -

Merci pour votre réponse,

le but du shell script serait seulement de lancer gnuplot pour afficher les invariants de l'exercice P11, avec les légendes et un style lisible, en une seule commande, pour que ça soit plus commode.

Mais si on peut l'utiliser, alors nous n'aurons pas besoin de lister les commandes dans le readme