Commit d0892f1a authored by Damien Morard's avatar Damien Morard
Browse files

Update Readme

parent 52f79f88
......@@ -10,10 +10,13 @@ Vous serez ainsi tenu au courant dès qu'une modification sera appliquée au dé
* Les cours ont lieu le mardi de 10h00 à 12h00
* Les exercices ont lieu le lundi de 16h00 à 18h00
* Team: Prof. Didier Buchs, Damien Morard
* Les TPs comptent pour 1/3 de la note.
* Utiliser les **issues** (tickets) de Gitlab pour communiquer ! Cela évitera d'avoir plusieurs fois la même question ! (Les issues sont sur votre barre des tâches tout à gauche)
* Pour toutes informations plus personnelles vous pouvez nous contacter par mail où directement venir à nos bureaux:
* `didier.buchs@unige.ch` (office 217)
* `damien.morard@unige.ch` (office 221)
* Pour ce cours vous êtes autorisé à utiliser [Prolog](https://fr.wikipedia.org/wiki/Prolog)
à la place de Swift pour la partie programmation. Cependant aucune aide supplémentaire ne sera fourni. Vous trouverez quelques ressources dans le cours et le reste sur Internet.
## Environnement
......@@ -27,7 +30,7 @@ Nous avons pris soin de rendre les choses aussi simple que possible.
ou directement en dualboot.
* [Atom](https://atom.io): L'éditeur de texte que nous utiliserons pour écrire le code.
Vous devez:
* [Surveiller(Watch)](https://gitlab.unige.ch/semantique/semantique_2019) avec la petite cloche en haut à droite de la page pour être tenu au courant des modifications à propos du cours.
* [Surveiller(Watch)](https://gitlab.unige.ch/semantique/semantique_2019) sur la page gitlab du cours avec la petite cloche en haut à droite pour être tenu au courant des modifications à propos du cours.
### Étapes à suivre attentivement
......@@ -63,7 +66,7 @@ Si vous faites le test comme indiqué avec la commande `ssh -T git@gitlab.com` e
Sur votre barre tout à gauche: Paramètres -> Membres
Pensez bien à mettre l'utilisateur avec le rôle `Maintainer`.
* Commenter l'issue #1 avec votre *Prénom + Nom*, *Le lien de votre profil Gitlab*, *Le lien de votre dépôt privé*, *Votre adresse mail universitaire*
* Commenter l'issue #1 avec votre `Prénom + Nom`, `Le lien de votre profil Gitlab`, `Le lien de votre dépôt privé`, `Votre adresse mail universitaire`.
Votre réponse aura cette forme (avec vos informations à la place des miennes)
E.g.
Damien Morard, @Damien.Morard, [Dépôt de Damien](https://gitlab.unige.ch/Damien.Morard/semantique), damien.morard@unige.ch.
......@@ -88,95 +91,97 @@ Les environnements installés contiennent:
Vous voudrez peut-être ajouter le package `language-swift`. (Peut-être aussi `autocomplete-swift`).
TODO: Suite à venir !
<!---
## Rules
* You must do your homework in your private fork of the course repository.
* You must fill your full name in your GitHub profile.
* If for any reason you have trouble with the deadline,
contact your teacher as soon as possible.
* The assistants must have access to your source code, but nobody else should have.
* Unless **explicitly** stated, the exercises are personal work. No collaboration, joint work or sharing of code will be tolerated. You can however discuss general approaches with your colleagues.
* Your source code (and tests) must pass all checks of `swift test`
without warnings or errors.
## Homework
* All homeworks are located in the `homework/` directory.
* There will be a specific subfolder for each homework (e.g. `homework/hw1_petrinets`). Use it. Do not rename the folder, place your solutions anywhere else, or do other things.
* do **not rename** any files, variables, functions, classes, ... unless you are instructed to do so!
* read the complete instructions **before** starting an assignment
* follow the instructions given to you in the assignments
* The swift compiler will warn you.
Make sure you don't see any warnings when you compile your code.
You can use `swift build` to run it.
* For testing, we use [XCTest](https://developer.apple.com/documentation/xctest).
* Vous **devez** faire vos travaux dans le **dépôt privé** que vous avez créé (après avoir fork toutes les données du cours).
* Si une raison fait que vous avez des problèmes avec la deadline, contactez
l'assistant aussi vite que possible. (Nous ferons en sorte de trouver une solution).
* L'assistant est le seul à avoir accès à votre code source (et personne d'autre).
* À moins que cela soit **formulé clairement**, les exercices sont des travaux personnels. Aucune collaboration, travail en commun ou bien encore partage de vos travaux ne sera toléré.
Vous pouvez cependant discuter de vos approches entre vous.
* Dès le début du cours, vous avez **2 Jokers**. Chaque Joker correspond à un jour bonus supplémentaire pour rendre vos TPs. C'est-à-dire que si vous dépassez la deadline donnée, un joker sera consommé et vous donnera un jour supplémentaire. Un joker est consommé dans son intégralité, aucune division n'est faite. Si vous dépassez la deadline ne serait-ce que d'une seconde un joker sera consommé.
**Une fois tous les Jokers consommés**, le dépassement de la deadline entraînera une note de **0**.
## TPs (Homeworks)
* Tous les travaux peuvent être trouvés dans le répertoir `TPs/`.
* Il y aura pour chaque TP un sous-répertoire à l'intérieur de `TPs/`.
* **Ne modifier en aucun cas** les fichiers à l'intérieur sauf si cela est explicitement mentionné !
* Lisez les consignes de manière complète et attentive avant de débuter un TP.
* Suivez bien les instructions que vous sont données pour faire vos TPs.
* Pour les TPs avec du code, il ne faut **aucune erreur de compilation ou de warning**. Si un code ne compile pas c'est **0**. Le compilateur de swift vous avertira s'il y a le moindre soucis de compilation ou de warning. (`swift build` pour compiler)
<!-- * For testing, we use [XCTest](https://developer.apple.com/documentation/xctest).
It is already installed in your environment,
and can run all the tests within the test folder files using: `swift test`.
-->
### Homework Deadlines
### TPs Deadlines
Vous avez jusqu'à 23:59:59 (*heure local de Genève*) par rapport à la date de jour de rendu pour mettre en ligne votre solution. Passez ce délai un Joker sera utilisé, et si vous n'avez plus de Joker la note sera de **0**.
Si vous rencontrez une situation difficile où vous avez besoin d'une extension, merci de nous prévenir à l'avance ! (À l'avance ne signifie pas deux heures avant la deadline)
You have until 23:59:59 on these dates to **push** your solutions to *your* (private) repository.
Generally: No late submissions, no extensions, no exceptions, no dogs eating homework.
If you are in an unfortuante circumstance where you do need an extension, tell us beforehand.
(Sending an email two hours before the deadline is *not* beforehand).
| No. | 1 | 2 | 3 | 4 | 5 | 6 |
| No. | 1 | 2 | 3 | 4 | / | / |
| ---- | -------- | -------- | -------- | -------- | -------- | -------- |
| Date | 10. Oct. | 24. Oct. | 7. Nov. | 21. Nov. | 5. Dec. | 19. Dec. |
| Date | | | | | | | |
### Mandatory Code Reviews
### TPs Reviews
* Additionally to submitting homework, you will also be invited to **mandatory** code reviews.
* Every week a handful of students will be randomly selected to come to the assistants' office and explain their code and what they have done.
* The reviews will be about 5 to 10 minutes long and you are expected to confidently present your work.
* These talks will be graded and will be counted towards your grade of the practical work.
* En plus des TPs à soumettre, vous serez invité à venir expliquer votre TP de manière occasionnel. Ceci est **obligatoire** et comptera pour une partie de la note des TPs.
* Chaque fois qu'un TP aura été rendu, une sélection aléatoire d'étudiant(e)s sera réalisée pour venir à nos bureux et expliquer leur TP.
* La review durera entre 5 et 10 minutes pendant lesquelles l'assistant pourra vous poser des questions en rapport avec le TP.
* La review sera évalué et comptera dans l'évaluation des travaux pratiques.
### Evaluation
* The grades of all six TPs + the average of your code review grades, devided by 7
* Here is an example oft the calculation, assuming there are three code reviews (CR). *Note that the number of actual CRs might differ in the end*
* La note finale de vos TPs sera calculé ainsi:
La moyenne de vos TPs reviews comptent pour un TP. Donc si vous avez 6 TPs la moyenne des TPs reviews comptera comme un 7 ème TP.
* Voici un exemple de comment le calcul sera effectué, en prenant en compte les reviews.
* Le nombre de TPs et de review donné dans l'exemple est à titre indicatif, et sert juste à expliquer le fonctionnement du calcul de la moyenne finale des TPs.
| TP1 | TP2 | TP3 | TP4 | TP5 | TP6 | CR1 | CR2 | CR3 |
| TP1 | TP2 | TP3 | TP4 | TP5 | TP6 | R1 | R2 | R3 |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| 4 | 5 | 4 | 5 | 6 | 5 | 6 | 4 | 5 |
Results in this grade:
Average of code reviews: (6 + 4 + 5) / 3 = 5
Final note = (4 + 5 + 4 + 5 + 6 + 5 + 5) / 7 = 4.85
### Getting Help
You should be old and smart enough to find the solutions to most problems by yourself. I.e.:
*If you encounter any problems, solve them!*
In case there is a problem you cannot solve, here is the order of escalation:
1. Google is your friend. (response time < 1 sec.)
2. Read the manual. (response time < 1 min.)
3. Ask a friend/colleague. (response time < 30 mins.)
4. Stackoverflow. [Learn how](https://stackoverflow.com/help/how-to-ask) (response time < 12 hrs.)
5. Course assistants. (response time < 1 day.)
6. Professor. (response time ???)
### Homework #0 (unmarked)
**Deadline 27.9.2018**
Make your environment work!
Specifically:
* [ ] did you `watch` this repo
* [ ] did you create your own **PRIVATE** repo, set this repo as a remote (follow the description above)
* [ ] did you give @stklik and @damdamo as collaborators
* [ ] did you assert that you can pull from this repository and push into your private one (`git pull course master;git push`)
* [ ] did you install swift?
* [ ] did you check if can you create a swift package? (`mkdir Hello;cd Hello;swift package init`)
* [ ] did you check that your swift package compiles? (`swift build`)
* [ ] did you check that you can test the swift package? (`swift test`)
* [ ] did you install a code editor? (i.e Atom)
* [ ] did you read the [Swift tutorial](https://kyouko-taiga.github.io/swift-thoughts/tutorial/)?
* [ ] did you reply to Issue [#1](https://github.com/cui-unige/modelisation-verification/issues/1) with your *full name*, *link to Github profile* (e.g. @stklik), *link to private repository*, *email address*
-->
Moyenne des TPs reviews: AR = (6 + 4 + 5) / 3 = 5
Note finale = (TP1 + TP2 + TP3 + TP4 + TP5 + TP6 + AR) / 7
= (4 + 5 + 4 + 5 + 6 + 5 + 5) / 7 = 4.85
### Obtenir de l'aide / Getting Help
Vous devez être assez mature et intelligent pour résoudre les problèmes par vous-mêmes.
I.e.:
*Si vous rencontre des problèmes, résolvez les !*
Dans la situation où vous n'arriveriez pas à résoudre un problème, voici la liste ordonnée des tâches à faire:
1. Google is your friend. (Temps de réponse < 1 sec.)
2. Read the manual. (Temps de réponse < 1 min.)
3. Demander à un ami/collègue. (Temps de réponse < 30 mins.)
4. Stackoverflow. [Apprenez](https://stackoverflow.com/help/how-to-ask) (Temps de réponse < 12 hrs.)
5. L'assistant. (Temps de réponse < 1 day.)
6. Professeur. (Temps de réponse ???)
### Homework #0 (Non noté)
**Deadline 25.02.2019**
Faites fonctionner votre environnement !
Plus spéficiquement :
* [ ] Avez-vous surveiller le dépôt ?
* [ ] Avez-vous créé votre propre dépôt privé, préparez le nécessaire expliqué ?
* [ ] Avez-vous testé le `git pull course master` pour récupérer les fichiers du cours ?
* [ ] Avez-vous ajouté @damien.morard comment collaborateur ?
* [ ] Avez-vous installé Swift ?
* [ ] Avez-vous vérifié si vous pouvez créer un package swift ? (`mkdir Hello;cd Hello;swift package init`)
* [ ] Avez-vous vérifié que vous pouvez compiler un package swift ? (`swift build`)
* [ ] Avez-vous vérifié que vous pouvez utiliser la fonction test de swift ? (`swift test`)
* [ ] Avez-vous installé un éditeur de code ? (i.e Atom)
* [ ] Avez-vous lu le [tutoriel swift](https://kyouko-taiga.github.io/swift-thoughts/tutorial/)?
* [ ] Avez-vous répondu à l'issue [#1](https://gitlab.unige.ch/semantique/semantique_2019/issues/1) avec votre `Prénom + Nom`, `Le lien de votre profil Gitlab`, `Le lien de votre dépôt privé`, `Votre adresse mail universitaire`. (Exemple disponible directement dans l'issue)
<!--
### Homework #1
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment