Skip to content

Commit 8f34ab6

Browse files
authored
Update README.md
1 parent 8ab61a7 commit 8f34ab6

1 file changed

Lines changed: 50 additions & 26 deletions

File tree

README.md

Lines changed: 50 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,60 @@
1-
<h1>Hand Tracking Mouse</h1>
1+
# Hand-Tracking-Mouse
22

3-
This project is a simple demonstration of using hand tracking to control the computer mouse. It uses OpenCV and MediaPipe for hand detection and tracking, and PyAutoGUI to control the mouse cursor.
4-
<h2>Requirements</h2>
3+
The Hand-Tracking-Mouse project is an innovative open-source initiative designed to offer an alternative way to control the computer mouse for individuals facing challenges with traditional mouse devices due to physical impairments or disabilities. Utilizing advanced hand tracking technology, this project enables users to navigate and interact with their computer using simple hand movements.
54

6-
This project requires the following libraries:
7-
<ul>
8-
<li>OpenCV</li>
9-
<li>MediaPipe</li>
10-
<li>PyAutoGUI</li>
11-
</ul>
12-
13-
You can install these libraries using pip:
5+
## Overview
146

15-
<code>pip install opencv-python mediapipe pyautogui</code>
7+
This project leverages the power of OpenCV and MediaPipe for precise hand detection and tracking, alongside PyAutoGUI for seamless mouse cursor control. It's a testament to how technology can be used to make computing accessible to everyone.
168

17-
<h2>Usage</h2>
9+
## Getting Started
1810

19-
To use this program, simply run the hand_tracking_mouse.py file:
11+
### Prerequisites
2012

21-
<code>python hand_tracking_mouse.py</code>
13+
Before you begin, ensure you have the following installed on your system:
14+
- Python 3.x
15+
- pip (Python package installer)
2216

23-
Once the program is running, it will use your computer's webcam to detect and track your hand movements. You can move your hand around to control the mouse cursor. To click, make a fist with your hand.
17+
### Installation
2418

25-
Press the 'q' key to quit the program.
26-
<h2>Credits</h2>
19+
1. Clone the repository to your local machine:
20+
git clone https://github.com/xn-coder/Hand-Tracking-Mouse.git
21+
2. Navigate to the project directory:
22+
cd Hand-Tracking-Mouse
23+
3. Install the required libraries using pip:
24+
pip install -r requirements.txt
2725

28-
This project was created by XNCoders. It uses the following libraries:
29-
<ul>
30-
<li>OpenCV: https://opencv.org/</li>
31-
<li>MediaPipe: https://mediapipe.dev/</li>
32-
<li>PyAutoGUI: https://pyautogui.readthedocs.io/en/latest/</li>
33-
</ul>
34-
<h2>License</h2>
26+
### Usage
3527

36-
This project is licensed under the MIT License. See the <b>LICENSE</b> file for more information.
28+
To start using the hand tracking mouse, run the following command in your terminal:
29+
python hand_tracking_mouse.py
30+
Once the program is running, it will use your computer's webcam to detect and track your hand movements. Move your hand to control the mouse cursor. To simulate a mouse click, make a fist with your hand.
31+
32+
Press the 'q' key at any time to exit the program.
33+
34+
## Libraries Used
35+
36+
- **OpenCV**: For image processing and hand detection.
37+
- **MediaPipe**: For robust hand tracking.
38+
- **PyAutoGUI**: For controlling the mouse cursor.
39+
40+
## Contributing
41+
42+
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
43+
44+
1. Fork the Project
45+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
46+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
47+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
48+
5. Open a Pull Request
49+
50+
## Acknowledgments
51+
52+
- [OpenCV](https://opencv.org/)
53+
- [MediaPipe](https://mediapipe.dev/)
54+
- [PyAutoGUI](https://pyautogui.readthedocs.io/en/latest/)
55+
56+
## About the Project
57+
58+
The Hand-Tracking-Mouse project is developed and maintained by XNCoders. It aims to provide a more accessible computing experience for individuals with physical impairments or disabilities, demonstrating the potential of hand tracking technology in everyday computing tasks.
59+
60+
Thank you for your interest in the Hand-Tracking-Mouse project. Your support and contributions are what drive the success and improvement of this initiative.

0 commit comments

Comments
 (0)