diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..41e9094 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -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). \ No newline at end of file diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..8e59118 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,31 @@ +
+ +# ![Robots](../docs/Images/iconRobot.svg)
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)** + +
+ +## 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`.
+ > 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. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..c10bb42 --- /dev/null +++ b/.github/SUPPORT.md @@ -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) diff --git a/README.md b/README.md deleted file mode 100644 index f398a72..0000000 --- a/README.md +++ /dev/null @@ -1,10 +0,0 @@ - -![Home](https://github.com/visose/Robots/raw/master/docs/Images/title.png) - -Create and simulate programs for ABB, KUKA, UR and Staubli robots. - -* 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. -* Download a [robot library](https://github.com/visose/robots/tree/master/libraries). -* Download the [example files](https://github.com/visose/robots/tree/master/samples) (they work with the Bartlett robot library). -* Read the [wiki](https://github.com/visose/robots/wiki). diff --git a/build/Assets/iconRobot.png b/build/Assets/iconRobot.png index 3400257..4b5ce3e 100644 Binary files a/build/Assets/iconRobot.png and b/build/Assets/iconRobot.png differ diff --git a/docs/Images/iconRobot.svg b/docs/Images/iconRobot.svg new file mode 100644 index 0000000..f831bf5 --- /dev/null +++ b/docs/Images/iconRobot.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/Images/title.png b/docs/Images/title.png deleted file mode 100644 index 65161ce..0000000 Binary files a/docs/Images/title.png and /dev/null differ