Added README
This commit is contained in:
70
README-fr.md
Normal file
70
README-fr.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# Programme de Dessin de Maison
|
||||
[](https://git.esiee.fr/frequela/snake2025/-/blob/tp1/README.md)
|
||||
[](https://git.esiee.fr/frequela/snake2025/-/blob/tp1/README-fr.md)
|
||||
|
||||
Ce programme dessine une maison simple avec un carré rouge pour le mur principal, un triangle bleu pour le toit, des rectangles colorés pour les fenêtres, et un cercle jaune pour le soleil en utilisant la bibliothèque graphique MLV.
|
||||
|
||||
## Fonctionnalités
|
||||
|
||||
- Dessine un carré rouge comme mur principal de la maison.
|
||||
- Dessine un triangle bleu comme toit de la maison.
|
||||
- Dessine deux rectangles colorés comme fenêtres de la maison.
|
||||
- Dessine un rectangle marron comme porte de la maison.
|
||||
- Dessine un cercle jaune comme soleil.
|
||||
- Affiche un message "Appuyez sur ESC pour quitter" et attend que l'utilisateur appuie sur la touche ESC pour fermer la fenêtre.
|
||||
|
||||
## Dépendances
|
||||
|
||||
- GCC (GNU Compiler Collection)
|
||||
- MLV (Mini Library for Visualization)
|
||||
|
||||
## Installation
|
||||
|
||||
### Installer MLV sur Ubuntu
|
||||
|
||||
1. Mettez à jour votre liste de paquets et installez les paquets requis :
|
||||
```sh
|
||||
sudo apt-get update
|
||||
sudo apt-get install build-essential gcc make libmlv3-dev
|
||||
```
|
||||
|
||||
### Compiler le Programme
|
||||
|
||||
1. Clonez le dépôt ou téléchargez le code source.
|
||||
2. Naviguez vers le répertoire contenant le `Makefile` et `maison.c`.
|
||||
3. Exécutez la commande suivante pour compiler le programme :
|
||||
```sh
|
||||
make
|
||||
```
|
||||
|
||||
Cela compilera `maison.c` et créera un exécutable nommé `maison`.
|
||||
|
||||
## Utilisation
|
||||
|
||||
1. Après avoir compilé le programme, exécutez l'exécutable :
|
||||
```sh
|
||||
./maison
|
||||
```
|
||||
|
||||
2. Une fenêtre s'ouvrira affichant la maison et le soleil. Appuyez sur la touche ESC pour fermer la fenêtre.
|
||||
|
||||
## Nettoyage
|
||||
|
||||
Pour nettoyer les fichiers de compilation, exécutez :
|
||||
```sh
|
||||
make clean
|
||||
```
|
||||
|
||||
Cela supprimera les fichiers objets et l'exécutable.
|
||||
|
||||
## Licence
|
||||
Ce projet est sous licence GPLv3. Pour plus de détails, voir [Licence GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).
|
||||
|
||||
## Auteurs
|
||||
|
||||
- Alex Frequelin (light_emerald@aostia.com)
|
||||
|
||||
## Remerciements
|
||||
|
||||
- Adrien Boussicault et Marc Zipstein pour la bibliothèque MLV.
|
||||
- ESIEE Paris pour les supports de cours et les conseils.
|
||||
129
README.md
129
README.md
@@ -1,93 +1,70 @@
|
||||
# snake2025
|
||||
# House Drawing Program
|
||||
[](https://git.esiee.fr/frequela/snake2025/-/blob/tp1/README.md)
|
||||
[](https://git.esiee.fr/frequela/snake2025/-/blob/tp1/README-fr.md)
|
||||
|
||||
This program draws a simple house with a red square for the main wall, a blue triangle for the roof, colored rectangles for the windows, and a yellow circle for the sun using the MLV graphics library.
|
||||
|
||||
## Features
|
||||
|
||||
## Getting started
|
||||
- Draws a red square as the main wall of the house.
|
||||
- Draws a blue triangle as the roof of the house.
|
||||
- Draws two colored rectangles as the windows of the house.
|
||||
- Draws a brown rectangle as the door of the house.
|
||||
- Draws a yellow circle as the sun.
|
||||
- Displays a message "Press ESC to quit" and waits for the user to press the ESC key to close the window.
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
## Dependencies
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
|
||||
## Add your files
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://git.esiee.fr/frequela/snake2025.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
|
||||
## Integrate with your tools
|
||||
|
||||
- [ ] [Set up project integrations](https://git.esiee.fr/frequela/snake2025/-/settings/integrations)
|
||||
|
||||
## Collaborate with your team
|
||||
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
|
||||
## Test and Deploy
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
|
||||
***
|
||||
|
||||
# Editing this README
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
|
||||
## Suggestions for a good README
|
||||
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
- GCC (GNU Compiler Collection)
|
||||
- MLV (Mini Library for Visualization)
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
|
||||
### Installing MLV on Ubuntu
|
||||
|
||||
1. Update your package list and install the required packages:
|
||||
```sh
|
||||
sudo apt-get update
|
||||
sudo apt-get install build-essential gcc make libmlv3-dev
|
||||
```
|
||||
|
||||
### Building the Program
|
||||
|
||||
1. Clone the repository or download the source code.
|
||||
2. Navigate to the directory containing the `Makefile` and `maison.c`.
|
||||
3. Run the following command to build the program:
|
||||
```sh
|
||||
make
|
||||
```
|
||||
|
||||
This will compile `maison.c` and create an executable named `maison`.
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
1. After building the program, run the executable:
|
||||
```sh
|
||||
./maison
|
||||
```
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
2. A window will open displaying the house and the sun. Press the ESC key to close the window.
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
## Cleaning Up
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
To clean up the build files, run:
|
||||
```sh
|
||||
make clean
|
||||
```
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
This will remove the object files and the executable.
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
This project is licensed under the GPLv3 License. For more details, see [GPLv3 License](https://www.gnu.org/licenses/gpl-3.0.en.html).
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
## Authors
|
||||
|
||||
- Alex Frequelin (light_emerald@aostia.com)
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
- Adrien Boussicault and Marc Zipstein for the MLV library.
|
||||
- ESIEE Paris for the course materials and guidance.
|
||||
Reference in New Issue
Block a user