docs/modern-cmake
docs
/
modern-cmake
mirror of
1
0
Fork 0
Code Issues Releases Wiki Activity

Clarify why we use a separate pages branch

This commit is contained in:
Achilleas Pipinellis 2016-04-11 08:39:50 +00:00
parent 99ff0c2425
commit 2e004ac918
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,8 +4,12 @@
Example [GitBook] website using GitLab Pages.
This project uses an orphan branch (`pages`) to host the book.
This way, you can have your project's code in the `master` branch and use `pages` for accommodating only your website content.
This project uses an orphan branch (`pages`) to host the book, since GitBook
[expects a README.md](http://toolchain.gitbook.com/structure.html) file present
in the root directory, and we already use one in the `master` branch to provide
information about GitBook on GitLab Pages. That way, you can have your project's
code in the `master` branch and use `pages` for accommodating only your website
content.
Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation http://doc.gitlab.com/ee/pages/README.html.