From f81bdbc1a8e341d9d3fe1eba3b77beadfe59b3d6 Mon Sep 17 00:00:00 2001
From: Brandon Mathis <brandon@imathis.com>
Date: Sat, 16 Jul 2011 09:29:09 -0400
Subject: Added support and documentation for deploying to subdirectories (like
 with gh-pages)

---
 README.markdown | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'README.markdown')

diff --git a/README.markdown b/README.markdown
index 2ebcd4e1..79ef8e18 100644
--- a/README.markdown
+++ b/README.markdown
@@ -118,6 +118,23 @@ The `config_deploy` rake task takes a branch name as an argument and creates a [
 This prepares your branch for easy deployment. The `rake deploy` task copies the generated blog from the `public` directory to the `_deploy` directory, adds new files, removes old files, sets a commit message, and pushes to Github.
 Github will queue your site for publishing (which usually occurs instantly or within minutes if it's your first commit).
 
+**Please note,** Github's project pages will be published to a subdirectory and you'll have to make sure you set up your urls correctly in your configs.
+
+For Octopress my cofigs would be set up like this:
+
+    # _config.yaml
+    destination: public/octopress
+    url: http://imathis.github.com/octopress
+    subscribe_rss: /octopress/atom.xml
+    root: /octopress
+
+    # config.rb
+    http_path = "/octopress"
+
+    # Rakefile
+    public_dir = "public/octopress"
+
+
 ## License
 (The MIT License)
 
-- 
cgit v1.2.1