Skip to content

Commit 6cd780e

Browse files
committed
Update README.md
1 parent a47b1ac commit 6cd780e

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,17 @@ Now, feel free to customize the theme however you like (don't forget to change t
3131
After you are done, you can deploy it to [GitHub Pages](https://pages.github.com/) by running the deploy script:
3232

3333
```bash
34-
$ ./bin/deploy
34+
$ ./bin/deploy [--user]
35+
```
36+
By default, the script uses the `master` branch for the source code and deploys the webpage to `gh-pages`.
37+
The optional flag `--user` tells it to deploy to `master` and use `source` for the source code instead.
38+
Using `master` for deployment is a convention for [user and organization pages](https://help.github.com/articles/user-organization-and-project-pages/).
39+
40+
**Note:** when deploying your user or organization page, make the `_config.yml` has `url` and `baseurl` fields as follows.
41+
42+
```
43+
url: <your-username>.github.io
44+
baseurl: # should be empty
3545
```
3646

3747
## Features

0 commit comments

Comments
 (0)