Zhengyiluo commited on
Commit
25fe337
·
verified ·
1 Parent(s): 7940be4

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +11 -25
README.md CHANGED
@@ -57,31 +57,17 @@ pipeline_tag: reinforcement-learning
57
 
58
  ## Quick Start
59
 
60
- ### Installation
61
-
62
- ```bash
63
- git clone https://github.com/ZhengyiLuo/GR00T-WholeBodyControl.git
64
- cd GR00T-WholeBodyControl
65
- git lfs pull
66
- ```
67
-
68
- For detailed installation instructions, see the [Installation Guide](https://zhengyiluo.github.io/GR00T-WholeBodyControl/getting_started/installation_deploy.html).
69
-
70
- ### Running SONIC
71
-
72
- ```bash
73
- # Navigate to deployment directory
74
- cd gear_sonic_deploy
75
-
76
- # Run with keyboard control
77
- python scripts/deploy_sonic.py --control_mode keyboard
78
-
79
- # Run with gamepad control
80
- python scripts/deploy_sonic.py --control_mode gamepad
81
-
82
- # Run with kinematic planner
83
- python scripts/deploy_sonic.py --use_planner
84
- ```
85
 
86
  ## Model Checkpoints
87
 
 
57
 
58
  ## Quick Start
59
 
60
+ 📚 **See the [Quick Start Guide](https://zhengyiluo.github.io/GR00T-WholeBodyControl/getting_started/quickstart.html)** for step-by-step instructions on:
61
+ - Installation and setup
62
+ - Running SONIC with different control modes (keyboard, gamepad, VR)
63
+ - Deploying on real hardware
64
+ - Using the kinematic planner
65
+
66
+ **Key Resources:**
67
+ - [Installation Guide](https://zhengyiluo.github.io/GR00T-WholeBodyControl/getting_started/installation_deploy.html) - Complete setup instructions
68
+ - [Keyboard Control Tutorial](https://zhengyiluo.github.io/GR00T-WholeBodyControl/tutorials/keyboard.html) - Get started with keyboard control
69
+ - [Gamepad Control Tutorial](https://zhengyiluo.github.io/GR00T-WholeBodyControl/tutorials/gamepad.html) - Set up gamepad control
70
+ - [VR Teleoperation Setup](https://zhengyiluo.github.io/GR00T-WholeBodyControl/getting_started/vr_teleop_setup.html) - Full-body VR control
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
 
72
  ## Model Checkpoints
73