diff --git a/README.md b/README.md index e826dcf..2dcd78d 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,51 @@ -# hardware -3D printed parts, circuits, electronic components and Arduino code +# πŸ“š Robotic Arm – Hardware Repository + +This repository contains the 3D models and solid components of the Robotic Arm with Computer Vision project. It focuses on the hardware build and connection with Arduino board. + +[![LicenΓ§a MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE) +[![Video Demo](https://img.shields.io/badge/YouTube-DemonstraΓ§Γ£o-red)](https://youtu.be/4t1daCFQ1OE) +[![OpenCV](https://img.shields.io/badge/OpenCV-4.7.0-blue)](https://opencv.org) + +--- + +## 🎯 Objectives + +This repository contains the **hardware** of the **ATOM Project**, a robotic arm controlled through computer vision and built using 3D printing and open-source hardware. While the overall project integrates electronics, and software, this repository focuses specifically on the mechanical and solid parts. + +The repository includes all source code related to: + +- 🧠 **Forearm, wrist and hand building**, using 3D printed pieces and electronical components. +- πŸ“‘ **Connection with Arduino**, we'll use cable connections to communicate with the arduino board. + +--- ``` -## Structure -hardware/ -β”œβ”€β”€ electronics/ # Schematics, wiring diagrams -β”‚ └── schematics/ -β”œβ”€β”€ arduino/ # Embedded code for microcontrollers -β”‚ β”‚ β”œβ”€β”€ main.ino -β”‚ β”‚ └── servo_control.ino -β”œβ”€β”€ mechanics/ -β”‚ β”œβ”€β”€ montagem.pdf -β”‚ └── medidas_estruturais.md -β”œβ”€β”€ 3d-models/ -β”‚ β”œβ”€β”€ STL/ -β”‚ └── Fusion360/ -β”œβ”€β”€ components-list.md # List of components used -β”œβ”€β”€ README.md -└── .gitignore +## πŸ“‚ Folder Structure +πŸ“¦ software +β”œβ”€β”€ πŸ“‚ .github # GitHub integration workflows and configs +β”œβ”€β”€ πŸ“‚ scripts # Needed scripts to the github project organization +β”œβ”€β”€ πŸ“„ LICENSE # Project MIT license +β”œβ”€β”€ πŸ“„ README.md # Main repository documentation ``` + +--- + +### Prerequisites +- Git version 2.25 or higher +- Access to a terminal/command line + +### Steps + +```bash +# 1. Clone the repository without checking out files +git clone --filter=blob:none --no-checkout https://github.com/username/repository.git +cd repository + +# 2. Enable sparse checkout +git sparse-checkout init --cone + +# 3. Set the folder you want to download +git sparse-checkout set path/to/folder + +# 4. Checkout the content +git checkout