diff options
| author | yuexiao-wang <wang.yuexiao@zte.com.cn> | 2017-10-12 20:20:08 +0800 |
|---|---|---|
| committer | yuexiao-wang <wang.yuexiao@zte.com.cn> | 2017-10-12 20:20:08 +0800 |
| commit | d9682749f99685ee3142ca65e61de1903670ce1c (patch) | |
| tree | f0588d2ec76abe8c35075dcd32afadeca2f145f3 | |
| parent | 4f4560659c8ad03c1b3c4bf204512d38fa94d791 (diff) | |
Modify the directory in generator
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
| -rw-r--r-- | generator/README.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/generator/README.md b/generator/README.md index 92340f19..3a2dd244 100644 --- a/generator/README.md +++ b/generator/README.md @@ -9,17 +9,17 @@ When an update happens to the this file, the next step is generate the accompanying documentation. This takes the format of two types of doc file: ``` -./sig-<sig-name>/README.md -./wg-<working-group-name>/README.md -./sig-list.md +sig-<sig-name>/README.md +wg-<working-group-name>/README.md +sig-list.md ``` For example, if a contributor has updated `sig-cluster-lifecycle`, the following files will be generated: ``` -./sig-cluster-lifecycle/README.md -./sig-list.md +sig-cluster-lifecycle/README.md +sig-list.md ``` ## How to use @@ -30,7 +30,7 @@ To (re)build documentation for all the SIGs, run these commands: make all ``` -To build docs for one SIG, run one these commands: +To build docs for one SIG, run one of these commands: ```bash make WHAT=sig-apps |