update readme

viwoqu · Sep 23, 2019 · 4c4145f · 4c4145f
1 parent d1d20f6
commit 4c4145f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,16 @@ MMSkeleton is developed on our research project [ST-GCN](https://github.com/yysi
 - [2019-09-23] Add video-based pose estimation demo.
 
 ## Getting Started
-Please see [INSTALL.md](./doc/INSTALL.md) and [START_RECOGNITION.md](./doc/START_RECOGNITION.md) for the basic usage of MMSkeleton.
+**Install** the mmskeleton:
+```shell
+python setup.py develop
+```
+To **verify** that mmskeleton installed correctly, use:
+```shell
+mmskl pose_demo [--gpus $GPUS]
+```
+
+Please see [INSTALL.md](./doc/INSTALL.md) and [START_RECOGNITION.md](./doc/START_RECOGNITION.md) for more details of MMSkeleton.
 
 ## Features
 

diff --git a/doc/START_POSE_ESTIMATION.md b/doc/START_POSE_ESTIMATION.md
@@ -4,7 +4,7 @@ We provide a demo for video-based pose estimation:
 ```shell
 mmskl pose_demo [--video $VIDEO_PATH] [--gpus $GPUS] [--$MORE_OPTIONS]
 ```
-This demo predict pose sequences via sequentially feeding frames into the image-based human detector and the pose estimator. By default, we use **cascade-rcnn** for detection and **hrnet** for estimation. To check the full usage, please run `mmskl pose_demo -h`. You can also refer to [pose_demo.yaml](../configs/pose_estimation/hrnet/pose_demo.yaml) for detailed configurations.
+This demo predict pose sequences via sequentially feeding frames into the image-based human detector and the pose estimator. By default, they are  **cascade-rcnn** and **hrnet** respectively. To check the full usage, please run `mmskl pose_demo -h`. You can also refer to [pose_demo.yaml](../configs/pose_estimation/hrnet/pose_demo.yaml) for detailed configurations.
 
 We also provide another demo `pose_demo_HD` with a slower but more powerful detector. Similarly, run:
 ```shell