add deployment details

ZEISS · Aug 9, 2024 · e7e692e · e7e692e
1 parent 8178c3e
commit e7e692e
Showing 1 changed file with 10 additions and 0 deletions.
diff --git 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)