diff --git a/images/leika.jpg b/images/leika.jpg new file mode 100644 index 0000000..acfd95c Binary files /dev/null and b/images/leika.jpg differ diff --git a/readme.md b/readme.md index e140e1c..5ea2bf6 100644 --- a/readme.md +++ b/readme.md @@ -1,49 +1,49 @@

-
- Leika + Leika -
+
Spot Micro - Leika ๐Ÿ•

+

A small quadruped robot, inspired by boston dynamic Spot.

-

A small quadruped robot, inspired by boston dynamic Spot.

- -

- Overview โ€ข - Key Features โ€ข - Documentation โ€ข - Credits โ€ข - License -

+

+ Explore the docs ยป + + +

[![Frontend Tests](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/frontend-tests.yml/badge.svg)](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/frontend-tests.yml) [![PlatformIO CI](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/embedded-build.yml/badge.svg)](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/embedded-build.yml) -
- -## ๐Ÿ“œ Overview -Leika is a smaller quadruped robot for the Spot-Micro community. -Built on an ESP32 and powered by FreeRTOS, she can handle multiple tasks seamlessly - Like video and data streaming, solving kinematic and gait planning, controlling IO and much more. + + +## ๐Ÿ“œ Overview + +Leika is a smaller quadruped robot for the Spot-Micro community. +Built on an ESP32 and powered by FreeRTOS, she can handle multiple tasks seamlessly - Like video and data streaming, solving kinematic and gait planning, controlling IO and much more. By focusing on practicality and simplicity in both hardware and software, it offer an accessible platform for learning, experimentation, and modest real-world applications. ## ๐ŸŽฏ Features -* **Live Preview**: Instant feedback with real-time updates. -* **Real-Time Data**: Stream camera feeds, monitor sensors, and analyze data on the fly. -* **Kinematic Precision**: Full kinematic model for accurate movements. -* **Dual joystick controller** -* **Robot mirroring visualization** -* **Highly customizable** -* **Self-Hosted**: Complete autonomy, from code to execution. +- **Live Preview**: Instant feedback with real-time updates. +- **Real-Time Data**: Stream camera feeds, monitor sensors, and analyze data on the fly. +- **Kinematic Precision**: Full kinematic model for accurate movements. +- **Dual joystick controller** +- **Robot mirroring visualization** +- **Highly customizable** +- **Self-Hosted**: Complete autonomy, from code to execution. ### ๐ŸŽฎ Controller controller -### ๐Ÿ› ๏ธ Documentation +### ๐Ÿ› ๏ธ Documentation You can find the current steps to get a fresh new doggo up and barking on [/docs](docs/readme.md) @@ -61,36 +61,37 @@ You can find a description for the current esp32 firmware and controller [here]( ## ๐Ÿ”ฎ Getting started 1. Clone and open the new project - ```sh - git clone https://github.com/runeharlyk/SpotMicroESP32-Leika - ``` + ```sh + git clone https://github.com/runeharlyk/SpotMicroESP32-Leika + ``` 1. Install dependencies with preferable package manager (npm, pnpm, yarn) - ```sh - cd app - pnpm install - ``` + ```sh + cd app + pnpm install + ``` 1. Configure device settings - 1. Update `factory_settings.ini` with relevant settings + + 1. Update `factory_settings.ini` with relevant settings 1. Upload filesystem image using platformIO 1. Upload firmware using platformIO -## ๐Ÿš€ Future +## ๐Ÿš€ Future See the [project backlog](https://github.com/users/runeharlyk/projects/3) and [open issues](https://github.com/runeharlyk/SpotMicroESP32-Leika/issues) for full list of proposed and active features (and known issues). -## ๐Ÿ™Œ Credits +## ๐Ÿ™Œ Credits This project takes great inspiration from the following resources: @@ -102,7 +103,7 @@ This project takes great inspiration from the following resources: 1. [Spot Micro - Leika](https://github.com/runeharlyk/SpotMicro-Leika/tree/main) 1. [NightDriverStrip](https://github.com/PlummersSoftwareLLC/NightDriverStrip) -## โ˜• Support +## โ˜• Support If you like the project and want to follow it evolving concidering โœจ-ing the project @@ -110,8 +111,8 @@ If you like the project and want to follow it evolving concidering โœจ-ing the p ## You may also like... -* [Spot Micro Quadruped Project - mike4192](https://github.com/mike4192/spotMicro) - Great ROS based project -* [SpotMicroAi](https://gitlab.com/public-open-source/spotmicroai) - Group repository with simulations and runtimes +- [Spot Micro Quadruped Project - mike4192](https://github.com/mike4192/spotMicro) - Great ROS based project +- [SpotMicroAi](https://gitlab.com/public-open-source/spotmicroai) - Group repository with simulations and runtimes ## ๐Ÿ“ƒ License