update the readme of generating doc

pull/21/head
Wen Zhang 5 years ago committed by Ganesha Upadhyaya
parent 7ed3b6d8b7
commit 70311ff629
  1. 19
      docs/README.md

@ -94,4 +94,21 @@ Here is some explanations
`Object URL`, then make it public!
## How to continue my work?
Step 0: clone the repo
```
$ npm install
```
Step 1: Generate a new Doc
```
$ cd docs
$ typedoc --out ./build ../packages/ --ignoreCompilerErrors --theme default --name Harmony_SDK_Doc --readme ../README.md
```
Step 2: Upload to S3 bucket
```
$ cd build
$ aws s3 cp ./ s3://your-bucket-name --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --recursive
```
Loading…
Cancel
Save