Skip to content

Commit d8a13c0

Browse files
author
Liuchuan Yu
committed
Add CONTRIBUTING.md
1 parent 00ed3a8 commit d8a13c0

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to XRoboToolkit-Unity-Client
2+
3+
Thank you for your interest in contributing to XRoboToolkit-Unity-Client! This document provides guidelines and instructions for contributors.
4+
5+
## Prerequisites
6+
7+
### Required Tools
8+
9+
- Unity
10+
- 2022.3.16f1 for starting from source
11+
- Other versions for starting from UnityPackage
12+
13+
### Recommended Knowledge
14+
15+
Be familiar with Unity development.
16+
17+
## Development Setup
18+
19+
### Start from Source
20+
21+
- git clone https://github.com/XR-Robotics/XRoboToolkit-Unity-Client.git
22+
- Open with Unity
23+
- Open Main Scene
24+
25+
### Start from UnityPackage
26+
27+
- Create a new project
28+
- Download `XRoboToolkit.unitypackage` from the release page
29+
- Import `XRoboToolkit.unitypackage`
30+
- Open Main Scene
31+
32+
## License
33+
34+
See the [LICENSE](LICENSE) file for details.
35+
36+
## Licenses and Attributions

0 commit comments

Comments
 (0)