diff --git a/README.md b/README.md index 1e5deb9..79ce772 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,165 @@ -# agent-aspirateur -Sujet du TP 1 d'intelligence artificielle. Création d’un agent aspirateur + +
+

+ +

Vacuum Agent

+ +

+ An vacuum intelligent agent created for the course of AI at UQAC. +
+ Explore the docs » +
+
+ Report Bug + · + Request Feature +

+

+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
  2. +
  3. + Getting Started + +
  4. +
  5. Usage
  6. +
  7. Roadmap
  8. +
  9. Contributing
  10. +
  11. License
  12. +
  13. Contact
  14. +
  15. Acknowledgements
  16. +
+
+ + + +## 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 + +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 + +See the [open issues](https://github.com/killian-mahe/agent-aspirateur/issues) for a list of proposed features (and known issues). + + + +## 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 + +Distributed under the MIT License. See `LICENSE` for more information. + + + + +## Contact + +Killian Mahé - [@killian-mahe](https://www.linkedin.com/in/killian-mah%C3%A9-246928135/) - killianmahe.pro@gmail.com + +Project Link: [https://github.com/killian-mahe/agent-aspirateur](https://github.com/killian-mahe/agent-aspirateur) + + + + +## 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) + + + + + + + +[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