From e7e692ef5faf594c9a020dc93fc62f27695cef7e Mon Sep 17 00:00:00 2001
From: Eddie-He-090 <40681449+Eddie-He-090@users.noreply.github.com>
Date: Fri, 9 Aug 2024 17:05:38 +0800
Subject: [PATCH] add deployment details

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 5dba9cd..5eba3da 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,18 @@
 
 A teeny tiny template to start a documentation.
 
+## Deploy
+
 It defaults to deploy to [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)
 
+1. fork [ZEISS/docs-template](https://github.com/ZEISS/docs-template)
+
+2. set `BASE_PATH` in `.github/workflows/pages.yml` as your repository name
+
+3. Go to **Settings** --> **Pages**
+
+4. select **GitHub Actions** in **Build and deployment**.
+
 ## License
 
 [MIT](/LICENSE)