From 293c28bfbc586e9a69d4c68178ba576d6e8a758c Mon Sep 17 00:00:00 2001 From: NestorDP Date: Sun, 23 Jul 2023 23:17:46 -0300 Subject: [PATCH] Created introduction section --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 48 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5b48a85..3f2a5e9 100755 --- a/README.md +++ b/README.md @@ -1,15 +1,57 @@ # littleBOT -This is an opensource project, your goal is to be a low-cost mobile robot that anyone can to use to learn robotics with the Robot Operating System. The littlebot project can also help you to study about important areas involved in robot development, such as: Embbeded systens, Control engineering, digital signal processing... +![Prints simulação LittleBOT](https://user-images.githubusercontent.com/37759765/128800773-a2714fbc-2218-4c7c-a7a5-e6070d67b1a1.png) -![Prints simulação LittleBOT](https://user-images.githubusercontent.com/37759765/128800773-a2714fbc-2218-4c7c-a7a5-e6070d67b1a1.png) +The Littlebot stack is an exciting and versatile package group to configure the Littlebot robot - a low-cost educational robot developed specifically for learning the principles of robotics. With a focus on simplicity, affordability, and educational value, the Littlebot robot serves as an ideal platform for students, hobbyists, and educators to delve into the fascinating world of robotics. + +**Key Features:** + +- Educational Focus: The Littlebot robot is purpose-built to help beginners grasp fundamental robotics concepts in a hands-on and engaging manner. +- ROS2 Compatibility: Leveraging the power of ROS2, the stack allows for efficient communication, control, and integration with various robotic components. +- Configurability: Customize the Littlebot robot's behavior and capabilities through easy-to-use configuration options provided by the ROS2 package. +- Extensibility: Expand the Littlebot's capabilities by adding your own ROS2 nodes and integrating additional sensors and actuators. + +Whether you are a student embarking on your robotics journey or an educator seeking an accessible platform for teaching robotics, the Littlebot ROS2 stack empowers you to explore, experiment, and learn in a fun and interactive manner. + + +**Simulation**: For those interested in simulating the Littlebot robot, we have a dedicated repository that provides details and resources for simulating the Littlebot using the powerful Gazebo simulation environment. You can find the simulation repository at the following link: + +[lttleBOT Gazebo](https://github.com/NestorDP/littlebot_gazebo) + +Please refer to the simulation repository for instructions on setting up the Littlebot simulation and exploring its capabilities virtually. + +**Hardware**: This repository serves as the ROS2 package for configuring the Littlebot robot. If you are interested in the hardware specifications and assembly instructions, please refer to the hardware documentation provided separately at the following link: + + [littleBOT firmware](https://github.com/NestorDP/littlebot_firmware) + +Get started by following the installation instructions below to set up the Littlebot ROS2 package on your system. We welcome contributions from the community to enhance and improve the Littlebot robot, making robotics education accessible to everyone. + + +## Table of Contents + +- [Installation](#installation) +- [Usage](#usage) +- [Configuration](#configuration) +- [Contributing](#contributing) +- [License](#license) +- [Credits](#credits) +- [Contact](#contact) + + + +## Installation + +## usage + +## configuration + +## contributing -# littleBOT family -If you want to have the complete environment to simulate and build a real littlebot, you will nedd outher repositories. Below you can find them: +## license -* [lttleBOT Gazebo](https://github.com/NestorDP/littlebot_gazebo): gazebo simulation +## credits -* [littleBOT firmware](https://github.com/NestorDP/littlebot_firmware): Firmware to real robot +## contact