Skip to content

Commit 4410ff3

Browse files
Enhance README with project details and features
Added detailed project features, structure, and instructions.
1 parent e564684 commit 4410ff3

1 file changed

Lines changed: 72 additions & 3 deletions

File tree

README.md

Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,74 @@
1-
# TriBot-X
1+
<div align="center">
2+
<h1>🤖 3-in-1 Multi-Mode Robot Car</h1>
3+
4+
<p>
5+
<b>A versatile robotic platform with Bluetooth, Obstacle Avoidance, and Human Following capabilities.</b>
6+
</p>
27

3-
[![GitHub release](https://img.shields.io/github/v/release/Krishna307dev/TriBot-X?style=for-the-badge&color=blue)](https://github.com/Krishna307dev/TriBot-X/releases)
8+
<!-- Badges -->
9+
<p>
10+
<a href="../../releases"><img src="https://img.shields.io/github/v/release/yourusername/yourrepo?style=for-the-badge&color=blue" alt="Latest Release"></a>
11+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge" alt="License"></a>
12+
<img src="https://img.shields.io/badge/Platform-Android_|_Arduino-orange.svg?style=for-the-badge" alt="Platform">
13+
</p>
14+
</div>
415

5-
... remaining content ...
16+
---
17+
18+
## 📖 Table of Contents
19+
- [✨ Features](#-features)
20+
- [📂 Project Structure](#-project-structure)
21+
- [📱 Controller App](#-controller-app)
22+
- [🛠️ Build Instructions & Diagram](#️-build-instructions--diagram)
23+
- [📦 Releases & Downloads](#-releases--downloads)
24+
- [📄 License](#-license)
25+
26+
## ✨ Features
27+
28+
- **📱 Bluetooth Control:** Drive the robot manually using the custom Android app.
29+
- **🛡️ Obstacle Avoidance:** Autonomous navigation avoiding collisions using ultrasonic and IR sensors.
30+
- **🚶‍♂️ Human Following:** Automatically detects and follows a person or object in front of it.
31+
32+
## 📂 Project Structure
33+
34+
This repository is organized logically for both the hardware source and the Android control layer:
35+
36+
```text
37+
├── AndroidApp/ # Android Controller App source code (Android Studio Project)
38+
├── ArduinoCode/ # Arduino firmware and robot logic
39+
├── diagrams/ # Circuit diagram files (PNG + SVG)
40+
├── BUILD_GUIDE.md # Setup and build instructions
41+
├── INSTRUCTIONS.md # Detailed usage guide
42+
├── LICENSE # MIT License
43+
└── README.md # This file
44+
```
45+
46+
## 🔌 Circuit Diagram
47+
48+
![Circuit Diagram](diagrams/diagram.png)
49+
50+
*The SVG version is available in the same folder for scalable viewing and editing.*
51+
52+
## 📱 Controller App
53+
54+
The custom Android app is designed specifically for this robot but is highly versatile.
55+
56+
**Note: The app can be used individually for other microcontrollers!**
57+
- It sends simple character commands via standard Serial over Bluetooth.
58+
- Examples: `M` for Manual mode, `Y` for Obstacle mode, `Z` for Follow mode.
59+
- You can easily pair it with any HC-05 or HC-06 Bluetooth module connected to your own custom Arduino, ESP32, STM32, or Raspberry Pi Pico projects.
60+
61+
## 🛠️ Build Instructions & Diagram
62+
63+
For complete setup, wiring, formatting, and installation steps, please refer to the dedicated instructions file.
64+
65+
👉 **[Read the Full Build Instructions Here!](INSTRUCTIONS.md)**
66+
67+
## 📦 Releases & Downloads
68+
69+
To download the compiled `.apk` for the Android App or grab the latest stable release of the hardware code, visit the Releases page.
70+
71+
👉 **[Download Latest Releases Here](../../releases)**
72+
73+
## 📄 License
74+
This project is open-source and available under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)