VACUUM CLEANER

❯ Home Goodness Sake

Built with the tools and technologies:

Table of Contents

• Overview
• Features
• Repository Structure
• Modules
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Tests
• Project Roadmap
• Contributing
• License
• Acknowledgments

---

Overview

❯ Development of Vacuum Cleaner in order to home goodness sake!

Cleaner.Simulation.2024-10-03.19-31-23.mp4

---

Features

❯ At the moment providing scenarios

---

Repository Structure

└── Vacuum_Cleaner/
    ├── README.md
    └── RobotVacuum
        ├── Makefile
        ├── main.cpp
        └── output.exe
	    |
	    RobotVacuum
            ├── Dlls....
            ├── main.cpp
            └── cleaner_simulation.exe

---

Modules

Robot Vacuum

File	Summary
main.cpp	❯ main CPP
main.cpp	❯ main Simulation CPP
Makefile	❯ Makefile
SFML Simulation	❯ SFML Simulation exe

---

Getting Started

Prerequisites

CPP: 11

Installation

Build the project from source:

1. Clone the Vacuum_Cleaner repository:

❯ git clone https://github.com/suaybdemir/Vacuum_Cleaner

2. Navigate to the project directory:

❯ cd Vacuum_Cleaner/SimulationSFML

3. Install the required dependencies:

❯ g++ -IC:/Users?/?/Desktop?/Vacuum_Cleaner/RobotVacuum/SimulationSFML/SFML/include -LC:/Users?/?/Desktop?/Vacuum_Cleaner/RobotVacuum/SimulationSFML/SFML/lib -o cleaner_simulation main.cpp -lsfml-graphics -lsfml-window -lsfml-system

Usage

To run the project, execute the following command:

❯ ./cleaner_simulation

Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the Vacuum_Cleaner project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/suaybdemir/Vacuum_Cleaner

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---