Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
visose committed Dec 4, 2021
1 parent 5649bb8 commit 707b04e
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

This project adheres to the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct).
31 changes: 31 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<div align="center">

# ![Robots](../docs/Images/iconRobot.svg)<br/>robots
### Create and simulate ABB, KUKA, UR and Staubli robot programs

[![License](https://img.shields.io/github/license/visose/Robots?style=flat-square)](../LICENSE)
[![Version](https://img.shields.io/github/v/release/visose/robots?style=flat-square)](../../../releases)
[![Repo stars](https://img.shields.io/github/stars/visose/robots?style=flat-square)](../../../)
[![Discussions](https://img.shields.io/github/discussions/visose/robots?style=flat-square)](../../../discussions)

**[About](#about)
[Install](#install)
[Docs](../../../wiki)**

</div>

## About

**Robots** is a plugin for **[Rhino's](https://www.rhino3d.com/)** **Grasshopper** visual programming interface. It allows users to create and simulate robot programs for **ABB**, **KUKA**, **UR** and **Staubli** robots. It works in **Rhino 7** for **Windows** and **MacOS**.

## Install
1. Install in **Rhino 7** using the `_PackageManager` command, search for `Robots`.
> If you have an older version, delete `Robots.gha` and `Robots.dll` from the `Grasshopper Components` folder.
1. Download at least one pair of `XML` and `3DM` files from the [libraries folder](../libraries).
> You can install multiple libraries.
1. Place them inside a folder named `Robots` under the OS's `Documents` folder.
> In Windows the path will look like `C:\Users\userName\Documents\Robots\RobotLibrary.xml`.<br/>
> In Mac the path will look like `HD/Users/userName/Robots/RobotLibrary.xml`.
1. Restart **Rhino** and open **Grasshopper**. There should be a new tab in **Grasshopper** named `Robots`.
1. The robots from the library should appear in a **value list** when you place a `Load Robot System` component.
1. Read the [docs](../../../wiki) for more info.
6 changes: 6 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## Support

If you have a question, or need help:
1. Check out the [docs](../../../wiki)
1. Search the [discussions](../../../discussions)
1. Ask a question [here](../../../discussions/new?category=q-a)
10 changes: 0 additions & 10 deletions README.md

This file was deleted.

Binary file modified build/Assets/iconRobot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/Images/iconRobot.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/Images/title.png
Binary file not shown.

0 comments on commit 707b04e

Please sign in to comment.