From 2e004ac9181e9e8c0357e9c147183a47299ddcf4 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Mon, 11 Apr 2016 08:39:50 +0000 Subject: [PATCH] Clarify why we use a separate pages branch --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f08f059..7d9023b 100644 --- a/README.md +++ b/README.md @@ -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.