diff --git a/README.md b/README.md index e0e625f..cdac75e 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,12 @@ If you're using GitHub: └── README.md ``` -2. Next push on `main` branch will build and deploy your documentation to `https://.github.io//`! +2. Commit and push on the `main` branch: your documentation will be built and deployed in the `gh-pages` branch. +3. Configure the Pages of your repository: + - Go to `Settings` > `Pages`. + - Source: select `Deploy from a branch`. + - Branch: select `gh-pages` and `/(root)` and Save. +5. Open `https://.github.io//` to see your documentation. If you're using GitLab, use the provided [`.gitlab-ci.yml`](https://github.com/NormandErwan/DocFxForUnity/blob/main/.gitlab-ci.yml). @@ -158,4 +163,4 @@ details. ## Disclaimer This repository is not sponsored by or affiliated with Unity Technologies or its affiliates. -“Unity” is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere. \ No newline at end of file +“Unity” is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.