]> git.bitcoin.ninja Git - blog/commitdiff
better serving it up instructions in readme
authorMark Otto <otto@github.com>
Sun, 22 Jun 2014 22:38:43 +0000 (15:38 -0700)
committerMark Otto <otto@github.com>
Sun, 22 Jun 2014 22:38:43 +0000 (15:38 -0700)
README.md

index 457adb9f93685b60bef789acff883b1b0f5f22b5..1e5626a00b8e70b0a55cdaec5fd70c12ab02e403 100644 (file)
--- a/README.md
+++ b/README.md
@@ -62,9 +62,14 @@ Open <http://localhost:4000> in your browser, and voilĂ .
 
 ### 4. Serving it up
 
-If you host your code on GitHub, you can use [GitHub Pages](https://pages.github.com) to host your project. Simply create a `gh-pages` branch in your repository and push it to GitHub. Then head to `http://username.github.io/repo-name`.
+If you host your code on GitHub, you can use [GitHub Pages](https://pages.github.com) to host your project.
 
-No matter your production or hosting setup, be sure to check your `baseurl` setting in the `_config.yml` file. For the above example, you'll want to change it from `/` to `/repo-name`. If you have a `CNAME` or host this at the root level of a domain, like `http://example.com`, there's no need to change anything. Not setting this correctly will mean broken styles on your site.
+1. Fork this repo and switch to the `gh-pages` branch.
+2a. If you're [using a custom domain name](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages), modify the `CNAME` file to point to your new domain.
+2b. If you're not using a custom domain name, **modify the `baseurl` in `_config.yml`** to point to your GitHub Pages URL. Example: for a repo at `github.com/username/poole`, use `http://username.github.io/poole/`. **Be sure to include the trailing slash.**
+3. Done! Head to your GitHub Pages URL or custom domain.
+
+No matter your production or hosting setup, be sure to verify the `baseurl` option file and `CNAME` settings. Not applying this correctly can mean broken styles on your site.
 
 
 ## Options