update readme

SwanHubX · Mar 4, 2025 · fd4bf8c · fd4bf8c
1 parent 4430aa3
commit fd4bf8c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # swanlab-docs
 
+[![](./assets/readme-1.png)](https://docs.swanlab.cn)
+
 为项目贡献的方式不仅仅是贡献代码，包括维护文档、在issue和群中答疑、提交bug等都是为swanlab项目贡献的方式！
 
 我们在[github仓库](https://github.com/SwanHubX/SwanLab-Docs)中托管了SwanLab的[官方文档](https://docs.swanlab.cn)，基于[vitepress](https://vitepress.dev/zh/guide/getting-started)。
@@ -14,6 +16,7 @@
 
 ```bash
 git clone https://github.com/SwanHubX/SwanLab-Docs
+cd SwanLab-Docs
 ```
 
 2. 安装依赖环境
@@ -24,6 +27,7 @@ git clone https://github.com/SwanHubX/SwanLab-Docs
 
 ```bash
 npm add -D vitepress
+npm install
 ```
 
 ### 本地运行文档

diff --git a/assets/readme-1.png b/assets/readme-1.png