Skip to content

Commit

Permalink
docs: Improve README (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
mithi authored Jul 11, 2020
1 parent ad5371f commit 256aae4
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,25 @@
[![HitCount](http://hits.dwyl.com/mithi/hexapod.svg)](http://hits.dwyl.com/mithi/hexapod)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier)
[![](https://img.shields.io/badge/Buy%20me%20-coffee!-orange.svg?logo=buy-me-a-coffee&color=795548)](https://ko-fi.com/minimithi)
[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-orange.svg?style=flat)](./CONTRIBUTING.md)


# Mithi's Bare-Minimum Hexapod Robot Simulator 2

<img src="https://mithi.github.io/robotics-blog/show-off.gif" alt="drawing" width="400" align="left" />

You can use this web app to solve inverse kinematics, simulate various gaits and so much more.
<p align="center">
<img src="https://mithi.github.io/robotics-blog/show-off.gif" alt="drawing" width="400" />
</p>

In real time, and at each step of the way, you can view all the angles the robot's eighteen joints make.
You can use this web app to solve inverse kinematics, simulate various gaits, and so much more. In real time, you can also view all the angles the robot's eighteen joints at any particular pose. All the computations are done in your browser, nobody's fetching data from wherever, so it should be fast. Another (somewhat) cool thing is that this project does NOT depend on any external mathematics libraries, just Javascript's built-in Math object.

Consider buying me [a few cups of coffee ☕ ☕ ☕](https://ko-fi.com/minimithi) to motivate me to build other robotics-related visualizers. (Quadrotors?!)

[🤖](https://hexapod.netlify.app/) [🐳](https://mithi.github.io/deep-blueberry/) [](https://ko-fi.com/minimithi)

## Features

<img src="https://mithi.github.io/robotics-blog/show-off-v2-1.gif" alt="drawing" width="325" align="right" />

[🤖](https://hexapod.netlify.app/) [🐳](https://mithi.github.io/deep-blueberry/) [](https://ko-fi.com/minimithi)

Control
- [x] The robot's dimensions
- [x] The robot's orientation and translation
- [x] The robot's 3d orientation, translation, stance, and more

Solve
- [x] Inverse Kinematics
Expand All @@ -39,15 +34,18 @@ Simulate
- [x] Walking forward and backwards
- [x] Rotating clockwise and counterclockwise

[🤖](https://hexapod.netlify.app/) [🐳](https://mithi.github.io/deep-blueberry/) [](https://ko-fi.com/minimithi)

## Screenshots

| ![](./public/img/screenshot4.png) | ![](./public/img/screenshot5.png) |![](./public/img/screenshot6.png) | ![](./public/img/screenshot3.png) |
|------|-------|------|-------|
| . | . | . | . |


## Main Contributors [![PRs welcome!](https://img.shields.io/badge/PRs-welcome-orange.svg?style=flat)](./CONTRIBUTING.md)

## Main Contributors
PRs welcome! Any contribution to improve the source code will be extremely appreciated. This is my first time coding in Javascript and this is also my first React app, so I'm sure there is a lot of room for improvement. [Contributing Guide](./CONTRIBUTING.md).
Any contribution to improve the source code is always appreciated. This is my first time coding in Javascript and this is also my first React app, so I'm sure there is a lot of room for improvement. [Contributing Guide](./CONTRIBUTING.md).

I will put your name below if I've merged your PR multiple times or if you've substantially contributed to this project in other ways.

Expand All @@ -58,8 +56,6 @@ I will put your name below if I've merged your PR multiple times or if you've su
## I love badges! (Don't we all?)

[![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg?style=flat)](https://opensource.org/licenses/Apache-2.0)
![](https://img.shields.io/codeclimate/maintainability-percentage/mithi/hexapod)
![](https://img.shields.io/codeclimate/maintainability/mithi/hexapod)
![](https://img.shields.io/codeclimate/issues/mithi/hexapod?label=code%20climate%20issues)
![](https://img.shields.io/github/last-commit/mithi/hexapod)
![](https://img.shields.io/github/commit-activity/m/mithi/hexapod?color=yellow&style=flat)
Expand Down

0 comments on commit 256aae4

Please sign in to comment.