diff --git a/README.md b/README.md index 23062a3cda899da287ecdfa458e163bbd807fc4d..badb87f50505646d82021fd2ab6e4ad7916d3cb3 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ -# VisualDL \ No newline at end of file +# VisualDL + + +### How to use +#### Step 1: build and install Python package +```shell +python setup.py bdist_wheel +cd dist +pip install visualdl-0.0.1-py2-none-any.whl +``` + +#### Step 2: build frontend +```shell +cd visualdl/frontend +npm install +npm run build +``` + +### Step 3: run +``` +python bin/visual_dl.py --port=8888 +``` \ No newline at end of file