diff --git a/README.md b/README.md index e96bee90..72526596 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ -Introduction ------------- +# Introduction git-tfs is a two-way bridge between TFS and git, similar to git-svn. -Use it like this: +# Usage + +## Cloning a repository git tfs clone http://tfs:8080/tfs/DefaultCollection $/some_project (wait for git-tfs to pull your history) @@ -14,33 +15,37 @@ Use it like this: (`cd some_project` and hack away, using only git, until you need to share with TFS...) -When you need to submit your changes to TFS, +## Pushing your changes to TFS + +### Check-in + + git tfs checkintool -`git tfs shelve A_SHELVESET_NAME` -or- -`git tfs checkin -m "Did stuff"` --or- -`git tfs checkintool` + + git tfs checkin -m "Did stuff" + +### Shelveset + + git tfs shelve A_SHELVESET_NAME + +## Other commands + + git tfs help -`git tfs help` for more info. +# Installing - -Installing ----------- - -Download (https://github.com/spraints/git-tfs/downloads#uploaded_downloads) -or build. +[Download](https://github.com/spraints/git-tfs/downloads#uploaded_downloads) or build. Add the directory that contains git-tfs.exe to your path. -I've been using this with (msysgit 1.7.3.1|http://code.google.com/p/msysgit/) for a while. +I've been using this with [msysgit 1.7.3.1](http://code.google.com/p/msysgit/) for a while. You need .NET 4 and either the 2008 or 2010 version of Team Explorer installed. -Building --------- +# Building msbuild (included in .NET 4) should be able to build the entire solution.