From 6cd780ef6d625e03a1a801e90af73928d4da2523 Mon Sep 17 00:00:00 2001 From: Maruan Al-Shedivat Date: Fri, 8 Sep 2017 13:01:41 -0400 Subject: [PATCH] Update README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 04e0897..9be12ca 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,17 @@ Now, feel free to customize the theme however you like (don't forget to change t After you are done, you can deploy it to [GitHub Pages](https://pages.github.com/) by running the deploy script: ```bash -$ ./bin/deploy +$ ./bin/deploy [--user] +``` +By default, the script uses the `master` branch for the source code and deploys the webpage to `gh-pages`. +The optional flag `--user` tells it to deploy to `master` and use `source` for the source code instead. +Using `master` for deployment is a convention for [user and organization pages](https://help.github.com/articles/user-organization-and-project-pages/). + +**Note:** when deploying your user or organization page, make the `_config.yml` has `url` and `baseurl` fields as follows. + +``` +url: .github.io +baseurl: # should be empty ``` ## Features