diff --git a/README.rdoc b/README.rdoc index f38480f27..2f68cc344 100644 --- a/README.rdoc +++ b/README.rdoc @@ -29,6 +29,24 @@ For more detailed information, check out our guide for Installing Git under Git http://docs.insoshi.com +== Setting up your local Git repository + + The Git Guides also detail our recommended setup for your local repository: + + * Clone of the official repository + git://github.com/insoshi/insoshi.git + * Your GitHub fork added as a remote repository + * Local tracking branches for official 'master' and 'edge' branches + * Local development branch based off 'edge' and pushed to your GitHub fork + + A shell script is available to automate this repository configuration: + + http://gist.github.com/18772 + + and is run using the command-line + + configure_insoshi_local.sh [GitHub Account Name] + == Install libraries and gems === Libraries diff --git a/configure_insoshi_local.sh b/configure_insoshi_local.sh index a3b8e3e96..1aceffcd3 100644 --- a/configure_insoshi_local.sh +++ b/configure_insoshi_local.sh @@ -56,6 +56,23 @@ echo # cd insoshi +# Create a local branch that tracks the forked master branch +# +echo "Creating local tracking branch for edge..." +git branch --track edge origin/edge +catch_error $? "creating local tracking branch for edge" + +# Create a local branch based off edge +# +echo "Creating local branch $BRANCH..." +git branch $BRANCH edge +catch_error $? "creating local branch $BRANCH" + +git checkout $BRANCH +catch_error $? "checking out local branch $BRANCH" + +echo + # Add forked repository as a remote repository connection # # The GitHub account name will be used to refer to this repository @@ -74,17 +91,6 @@ catch_error $? "fetching branches from remote $REMOTE" echo -# Create a local branch that tracks the forked master branch -# -echo "Creating local branch $BRANCH..." -git branch --track $BRANCH $REMOTE/master -catch_error $? "creating local branch $BRANCH" - -git checkout $BRANCH -catch_error $? "checking out local branch $BRANCH" - -echo - # Create the matching remote branch on the forked repository # # We need to explicitly create the branch via a push command