update readme

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material mkdocs-awesome-pages-plugin mkdocs-material-extensions
+      - run: pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin mkdocs-material-extensions
       - run: |
           cd $GITHUB_WORKSPACE
 

README.md

@@ -4,4 +4,29 @@ This project mainly describes the document node types supported by sdoc files an
 
 ## Document address
 
-https://haiwen.github.io/seadoc-specification/seadoc/
+https://haiwen.github.io/seadoc-specification/
+
+## How to use 
+
+### Install Dependencies
+```
+pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin mkdocs-material-extensions
+```
+
+### Start a Project
+```
+mkdocs serve
+```
+
+### Open the webpage
+
+If you open the webpage and can see the locally deployed project, it means that you have completed the local environment setup
+
+![The test page](./assets/test-page.png)
+
+## Others
+
+If you have any problems with your local python, you can refer to this document [Python Problems and Solutions](https://dev.seafile.com/seahub/f/6a0408941ceb4fc49608/)
+
+
+