diff --git a/README.md b/README.md index 5dba9cd..86cfdfc 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)