Skip to content

Commit

Permalink
Ajout d'un fichier Pipfile.lock et amélioration du site web
Browse files Browse the repository at this point in the history
  • Loading branch information
younesaassila committed Jun 20, 2020
1 parent ed10c06 commit feecfb0
Show file tree
Hide file tree
Showing 11 changed files with 323 additions and 71 deletions.
32 changes: 16 additions & 16 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@ nationalité.

Exemples de comportements qui contribuent à créer un environnement positif :

* l'utilisation d'un langage ouvert et accueillant
* le respect des différents points de vue et expériences vécues
* accepter poliment les critiques constructives
* se concentrer sur ce qui est meilleur pour la communauté
* faire preuve d'empathie envers les autres membres de la communauté
- l'utilisation d'un langage ouvert et accueillant
- le respect des différents points de vue et expériences vécues
- accepter poliment les critiques constructives
- se concentrer sur ce qui est meilleur pour la communauté
- faire preuve d'empathie envers les autres membres de la communauté

Exemples de comportements non acceptables :

* l'utilisation de langage ou d'imagerie sexualisés et les avances sexuelles non
- l'utilisation de langage ou d'imagerie sexualisés et les avances sexuelles non
sollicitées
* le _trolling_, les commentaires insultants ou désobligeants, et les attaques
- le _trolling_, les commentaires insultants ou désobligeants, et les attaques
personnelles ou d'ordre politique
* le harcèlement en public ou en privé
* la publication d'informations privées de tierces personnes, telles que des
- le harcèlement en public ou en privé
- la publication d'informations privées de tierces personnes, telles que des
adresses physiques ou électroniques, sans permission explicite
* toute conduite qui pourrait être raisonnablement considérée comme inappropriée
- toute conduite qui pourrait être raisonnablement considérée comme inappropriée
dans le milieu professionnel

## Nos responsabilités
Expand Down Expand Up @@ -59,12 +59,12 @@ projet.
## Application

Les cas de comportements abusifs, harcelants ou tout autre comportement
inacceptable peuvent être signalés en contactant l'équipe du projet.
Toutes les plaintes seront examinées et étudiées
et se traduiront par une réponse appropriée aux
circonstances. L'équipe du projet s'engage à garder confidentielles les
informations de la personne qui remonte un incident. Plus de détails sur
la politique de mise en application des règles peuvent être publiés séparément.
inacceptable peuvent être signalés en contactant l'équipe du projet. Toutes les
plaintes seront examinées et étudiées et se traduiront par une réponse
appropriée aux circonstances. L'équipe du projet s'engage à garder
confidentielles les informations de la personne qui remonte un incident. Plus de
détails sur la politique de mise en application des règles peuvent être publiés
séparément.

Les membres du projet qui ne suivent ou qui n'appliquent pas le Code de
Conduite de bonne foi s'exposent temporairement ou de façon permanente à des
Expand Down
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

Vous avez la possibilité de contribuer au projet en rapportant un bug, en suggérant une nouvelle fonctionnalité ou en ajoutant le support d'un exercice.

Pour contribuer au projet, vous devez avoir installé le module `pipenv`.
Celui-ci permet d'enregistrer les dépendances du programme dans le fichier
`Pipfile.lock`. Ce fichier facilite le développement de Kwyk Solver.

Pour plus d'informations sur `pipenv` rendez-vous à
[https://github.com/pypa/pipenv](https://github.com/pypa/pipenv).

## Rapporter un bug ou suggérer une nouvelle fonctionnalité

Pour rapporter un bug ou suggérer une nouvelle fonctionnalité, veuillez vous rendre dans [l'onglet "Issues" et cliquer sur le bouton "New issue"](https://github.com/Yougi3/Kwyk-Solver/issues/new/choose).
Expand All @@ -10,7 +17,7 @@ Pour rapporter un bug ou suggérer une nouvelle fonctionnalité, veuillez vous r

Pour ajouter le support d'un exercice, vous aurez besoin d'effectuer un fork du projet Kwyk Solver puis de proposer vos améliorations à l'aide d'une pull request.

Pour plus d'information sur le fonctionnement de Git et de GitHub, nous vous recommandons [la playlist YouTube dédiée à ces sujets sur la chaîne YouTube "The Coding Train" (anglais)](https://www.youtube.com/playlist?list=PLRqwX-V7Uu6ZF9C0YMKuns9sLDzK6zoiV).
Pour plus d'informations sur le fonctionnement de Git et de GitHub, nous vous recommandons [la playlist YouTube dédiée à ces sujets sur la chaîne YouTube "The Coding Train" (anglais)](https://www.youtube.com/playlist?list=PLRqwX-V7Uu6ZF9C0YMKuns9sLDzK6zoiV).

Pour ajouter le support d'un exercice, veuillez :

Expand Down
14 changes: 14 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

[dev-packages]

[packages]
numpy = "*"
scipy = "*"
requests = "*"

[requires]
python_version = "3.8"
113 changes: 113 additions & 0 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Nous encourageons ses utilisateurs à ajouter le support d'exercices pour rendre

Ce projet accueille à bras ouverts les contributions de ses utilisateurs. Si vous souhaitez rapporter un bug, suggérer une nouvelle fonctionnalité ou ajouter le support d'un exercice, vous êtes le bienvenu !

Pour plus d'information, veuillez lire les fichiers [CODE_OF_CONDUCT.md](https://github.com/Yougi3/Kwyk-Solver/blob/master/CODE_OF_CONDUCT.md) et [CONTRIBUTING.md](https://github.com/Yougi3/Kwyk-Solver/blob/master/CONTRIBUTING.md).
Pour plus d'informations, veuillez lire les fichiers [CODE_OF_CONDUCT.md](https://github.com/Yougi3/Kwyk-Solver/blob/master/CODE_OF_CONDUCT.md) et [CONTRIBUTING.md](https://github.com/Yougi3/Kwyk-Solver/blob/master/CONTRIBUTING.md).

## Installation de Kwyk Solver

Expand Down
33 changes: 0 additions & 33 deletions docs/download.html

This file was deleted.

22 changes: 22 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html lang="fr">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" href="style.css" />
<title>Kwyk Solver</title>
</head>
<body>
<header>
<h1>Kwyk Solver</h1>
<p>Un outil open source pour résoudre vos devoirs Kwyk.</p>
<div>
<button id="download-button" class="button-fill">Télécharger</button>
<button id="github-button">Page GitHub</button>
</div>
</header>
<main id="main"></main>
<script src="https://cdnjs.cloudflare.com/ajax/libs/markdown-it/11.0.0/markdown-it.min.js"></script>
<script src="index.js"></script>
</body>
</html>
46 changes: 46 additions & 0 deletions docs/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
const md = window.markdownit();
const downloadButton = document.getElementById("download-button");
const gitHubButton = document.getElementById("github-button");
const main = document.getElementById("main");

//#region Download button

const dlUrlRequest = new XMLHttpRequest();
dlUrlRequest.onreadystatechange = () => {
if (dlUrlRequest.readyState == 4 && dlUrlRequest.status == 200) {
const url = JSON.parse(dlUrlRequest.responseText).url;
downloadButton.addEventListener("click", () => {
location.href = url;
});
}
};
dlUrlRequest.open("GET", "update_info.json", true);
dlUrlRequest.send();

//#endregion

//#region Main, README

const readMeRequest = new XMLHttpRequest();
readMeRequest.onreadystatechange = () => {
if (readMeRequest.readyState == 4 && readMeRequest.status == 200) {
const html = md.render(readMeRequest.responseText);
main.innerHTML = html;
}
};
readMeRequest.open(
"GET",
"https://raw.githubusercontent.com/Yougi3/Kwyk-Solver/master/README.md",
true
);
readMeRequest.send();

//#endregion

//#region GitHub button

gitHubButton.addEventListener("click", () => {
location.href = "https://github.com/Yougi3/Kwyk-Solver";
});

//#endregion
Loading

0 comments on commit feecfb0

Please sign in to comment.