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 @@
+
- - Overview โข - Key Features โข - Documentation โข - Credits โข - License -
++ Explore the docs ยป + + +
[](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/frontend-tests.yml) [](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/embedded-build.yml) -
-### ๐ ๏ธ 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