This repository has been archived by the owner on Oct 19, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f60a9ca
commit 299ee0e
Showing
1 changed file
with
165 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,165 @@ | ||
| # agent-aspirateur | ||
| Sujet du TP 1 d'intelligence artificielle. Création d’un agent aspirateur | ||
| <!-- PROJECT LOG --> | ||
| <br /> | ||
| <p align="center"> | ||
|
|
||
| <h3 align="center">Vacuum Agent</h3> | ||
|
|
||
| <p align="center"> | ||
| An vacuum intelligent agent created for the course of AI at UQAC. | ||
| <br /> | ||
| <a href="https://github.com/killian-mahe/agent-aspirateur"><strong>Explore the docs »</strong></a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/killian-mahe/agent-aspirateur/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/killian-mahe/agent-aspirateur/issues">Request Feature</a> | ||
| </p> | ||
| </p> | ||
|
|
||
|
|
||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details open="open"> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about-the-project">About The Project</a> | ||
| <ul> | ||
| <li><a href="#built-with">Built With</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#getting-started">Getting Started</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| </ul> | ||
| </li> | ||
| <li><a href="#usage">Usage</a></li> | ||
| <li><a href="#roadmap">Roadmap</a></li> | ||
| <li><a href="#contributing">Contributing</a></li> | ||
| <li><a href="#license">License</a></li> | ||
| <li><a href="#contact">Contact</a></li> | ||
| <li><a href="#acknowledgements">Acknowledgements</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| ## About The Project | ||
|
|
||
| The goal of this project was to create a vacuum agent that will must clean all the room of a hotel. | ||
|
|
||
| ### Subject | ||
|
|
||
| You have a large mansion with many rooms that are constantly getting dirty. Since your maintenance workers have joined a union, they've been asking to work terrible hours (8 to 16, you guessed it!) and to get breaks during the day. Too bad for them! You decide to order an Aspirobot T-0.1 to replace all these lazy people. After all, the company guaranteed that it would avoid vacuuming your expensive jewellery (it would be sad to lose a $15,000 diamond for a bit of dust) and that it would automatically keep a maximum of rooms clean at all times without wasting electricity! | ||
|
|
||
| ### Built With | ||
|
|
||
| This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. | ||
| * [Python 3.9](https://www.python.org/) | ||
| * [PyQt5](https://wiki.python.org/moin/PyQt) | ||
|
|
||
|
|
||
| <!-- GETTING STARTED --> | ||
| ## Getting Started | ||
|
|
||
| This project is based on Python. No framework is needed, but you must install the PyQt5 package. | ||
| We strongly suggest your to create a virtual environment to create the app environment. | ||
|
|
||
| ### Installation | ||
|
|
||
| Before clonning the repository, you should create a new virtual environment (using `venv` for exemple). | ||
|
|
||
| 1. Clone the project | ||
| ```sh | ||
| git clone https://github.com/killian-mahe/agent-aspirateur.git | ||
| ``` | ||
| 2. Install virtual environment | ||
| ```sh | ||
| cd agent-aspirateur && python3 -m venv env | ||
| ``` | ||
| 3. Activate the new environment | ||
| ```sh | ||
| source env/bin/activate | ||
| ``` | ||
| 4. Install required packages | ||
| ```sh | ||
| pip install -r /path/to/requirements.txt | ||
| ``` | ||
|
|
||
| ### Use | ||
|
|
||
| 1. Start the project | ||
| ```sh | ||
| python vacuum-agent | ||
| ``` | ||
|
|
||
| <!-- ROADMAP --> | ||
| ## Roadmap | ||
|
|
||
| See the [open issues](https://github.com/killian-mahe/agent-aspirateur/issues) for a list of proposed features (and known issues). | ||
|
|
||
|
|
||
| <!-- CONTRIBUTING --> | ||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
|
|
||
|
|
||
| <!-- LICENSE --> | ||
| ## License | ||
|
|
||
| Distributed under the MIT License. See `LICENSE` for more information. | ||
|
|
||
|
|
||
|
|
||
| <!-- CONTACT --> | ||
| ## Contact | ||
|
|
||
| Killian Mahé - [@killian-mahe](https://www.linkedin.com/in/killian-mah%C3%A9-246928135/) - [email protected] | ||
|
|
||
| Project Link: [https://github.com/killian-mahe/agent-aspirateur](https://github.com/killian-mahe/agent-aspirateur) | ||
|
|
||
|
|
||
|
|
||
| <!-- ACKNOWLEDGEMENTS --> | ||
| ## Acknowledgements | ||
| * [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) | ||
| * [Img Shields](https://shields.io) | ||
| * [Choose an Open Source License](https://choosealicense.com) | ||
| * [GitHub Pages](https://pages.github.com) | ||
| * [Animate.css](https://daneden.github.io/animate.css) | ||
| * [Loaders.css](https://connoratherton.com/loaders) | ||
| * [Slick Carousel](https://kenwheeler.github.io/slick) | ||
| * [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll) | ||
| * [Sticky Kit](http://leafo.net/sticky-kit) | ||
| * [JVectorMap](http://jvectormap.com) | ||
| * [Font Awesome](https://fontawesome.com) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| [contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors | ||
| [forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [forks-url]: https://github.com/othneildrew/Best-README-Template/network/members | ||
| [stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers | ||
| [issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [issues-url]: https://github.com/othneildrew/Best-README-Template/issues | ||
| [license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt | ||
| [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 | ||
| [linkedin-url]: https://linkedin.com/in/othneildrew | ||
| [product-screenshot]: images/screenshot.png |