Skip to content

Commit

Permalink
docs: Update readme (#110)
Browse files Browse the repository at this point in the history
  • Loading branch information
mithi authored Jul 7, 2020
1 parent c3ee317 commit 1aba32e
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,31 @@
# Mithi's Bare-Minimum Hexapod Robot Simulator Rewrite
_(in Javascript!)_

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

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

- Solve (and visualize) forward and inverse kinematics purely on your browser! It's a complete rewrite of the [one I wrote in Python 🐍](https://github.com/mithi/hexapod-robot-simulator). Extremely fast! Zero server-side computations!

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

- See: [https://hexapod.netlify.app](https://hexapod.netlify.app)

## Contributions Welcome! [![first-timers-only](https://img.shields.io/badge/first--timers--only-friendly-blueviolet.svg?style=flat)](https://www.firsttimersonly.com/) [![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](./CONTRIBUTING.md) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](https://www.contributor-covenant.org/)
## Contributions Welcome!

- Any contribution to improve the source code will be extremely appreciated. 💙 Anything. Anything at all. 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.
- Any contribution to improve the source code will be extremely appreciated. 💙 Anything. Anything at all. 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).

![](./public/img/screenshot2.png)
| <img src="./public/img/screenshot1.png" alt="drawing" width="290" /> | <img src="./public/img/screenshot2.png" alt="drawing" width="450" /> | <img src="./public/img/screenshot4.png" alt="drawing" width="160" /> |
|----|----|----|
| . | . | . |

| <img src="./public/img/screenshot1.png" alt="drawing" width="600" /> | <img src="./public/img/screenshot4.png" alt="drawing" width="305" /> |
|---|---|
| . | . |
## Main Contributors
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.

- [@mithi](https://github.com/mithi)
- [@icyJoseph](https://github.com/icyJoseph)
- [@mikong](https://github.com/mikong)

## [](https://ko-fi.com/minimithi) I love badges! (Don't we all?)
## 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)
Expand Down

0 comments on commit 1aba32e

Please sign in to comment.