diff --git a/README.md b/README.md new file mode 100644 index 0000000..caa3aad --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# PiLiDAR - Hardware + +This repository contains the hardware design files and related resources for the PiLiDAR project. + +## Overview + +PiLiDAR-Hardware is part of the PiLiDAR initiative and provides all the necessary hardware documentation, schematics, and resources needed for building and developing with PiLiDAR systems. + +## Repository Structure + +- **CAD/**: CAD design files for PiLiDAR hardware components. + - View and edit with [FreeCAD](https://www.freecad.org/) or [KiCad](https://www.kicad.org/). +- **Datasheets/**: Datasheets for hardware components used in the project. +- **FDM/**: Files related to Fused Deposition Modeling (3D printing). + - Open, view, or slice with [Ultimaker Cura](https://ultimaker.com/software/ultimaker-cura/) or [PrusaSlicer](https://www.prusa3d.com/page/prusaslicer_424/). +- **Fritzing/**: Fritzing project files and diagrams for prototyping. + - Explore with the [Fritzing](https://fritzing.org/) application. +- **images/**: Reference images and diagrams. +- **.gitignore**: Git configuration to exclude certain files/folders from version control. +- **LICENSE.md**: License information for this project. + +## Getting Started + +1. Clone the repository: + ```sh + git clone https://github.com/PiLiDAR/PiLiDAR-Hardware.git + ``` +2. Explore the hardware design files and documentation in the repository. + +## License + +This project is licensed under the terms described in [LICENSE.md](LICENSE.md). + +## Contributing + +Contributions are welcome! Please open an issue or submit a pull request if you have suggestions or improvements. + +--- + +For more information, see: +- PiLiDAR organization on GitHub: [https://github.com/PiLiDAR](https://github.com/PiLiDAR) +- Ongoing discussion on Reddit: https://www.reddit.com/r/LiDAR/comments/1hs6byu/pilidar_the_diy_opensource_3d_scanner_is_now/