Skip to content
This repository
Newer
Older
100644 196 lines (132 sloc) 6.975 kb
877f5fe8 »
2010-12-06 Fix placement.
1 git-flow ![Project status](http://stillmaintained.com/nvie/gitflow.png)
6c2d30bb »
2010-01-26 Structurally replace gitflow by git-flow, as a true git extension.
2 ========
12c4ab4f »
2010-01-26 Update README file to mention new available features.
3 A collection of Git extensions to provide high-level repository operations
4fc0bc16 »
2010-02-24 Use a more friendly URL for the original blog post URL.
4 for Vincent Driessen's [branching model](http://nvie.com/git-model "original
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
5 blog post").
6
7
12c4ab4f »
2010-01-26 Update README file to mention new available features.
8 Installing git-flow
9 -------------------
e26bfbc5 » agross
2010-11-02 Adding more detailed installation information for Windows users on Cy…
10
11 ### Mac OS
12 If you're on a Mac and use [homebrew](http://github.com/mxcl/homebrew), it's simple:
4f0f5391 »
2010-07-10 Added Rick Osborne's super-easy gitflow installer oneliner to the pro…
13
149d1544 »
2010-10-20 Add installation instructions for homebrew and MacPorts.
14 $ brew install git-flow
15
e26bfbc5 » agross
2010-11-02 Adding more detailed installation information for Windows users on Cy…
16 If you're on a Mac and use [MacPorts](http://macports.org/), it's simple:
4f0f5391 »
2010-07-10 Added Rick Osborne's super-easy gitflow installer oneliner to the pro…
17
149d1544 »
2010-10-20 Add installation instructions for homebrew and MacPorts.
18 $ port install git-flow
c213052c » defeated
2010-09-05 added OSX instructions using curl (because wget isn't available by de…
19
e26bfbc5 » agross
2010-11-02 Adding more detailed installation information for Windows users on Cy…
20 ### Linux, etc.
149d1544 »
2010-10-20 Add installation instructions for homebrew and MacPorts.
21 Another easy way to install git-flow is using Rick Osborne's excellent git-flow
22 installer, which can be run using the following command:
23
6f199b97 »
2010-11-11 Make Github download URL in README https.
24 $ wget -q -O - https://github.com/nvie/gitflow/raw/develop/contrib/gitflow-installer.sh | sudo sh
c213052c » defeated
2010-09-05 added OSX instructions using curl (because wget isn't available by de…
25
e26bfbc5 » agross
2010-11-02 Adding more detailed installation information for Windows users on Cy…
26 ### Windows
27 #### Using Cygwin
28 For Windows users who wish to use the automated install, it is suggested that you install [Cygwin](http://www.cygwin.com/)
29 first to install tools like `git`, `util-linux` and `wget` (with those three being packages that can be selected
30 during installation). Then simply run this command from a Cygwin shell:
31
6f199b97 »
2010-11-11 Make Github download URL in README https.
32 $ wget -q -O - https://github.com/nvie/gitflow/raw/develop/contrib/gitflow-installer.sh | sh
e26bfbc5 » agross
2010-11-02 Adding more detailed installation information for Windows users on Cy…
33
34 #### Using msysgit
35 This is much like the manual installation below, but there are additional steps required to install some extra tools that
36 are not distributed with [msysgit](http://code.google.com/p/msysgit/).
37
38 After cloning the git-flow sources from Github, also fetch the submodules:
39
40 $ git submodule init
41 $ git submodule update
42
43 Copy git-flow's relevant files to your msysgit installation directory:
44
45 $ mkdir /usr/local/bin
46 $ cp git-flow* gitflow* /usr/local/bin/
47 $ cp shFlags/src/shflags /usr/local/bin/gitflow-shFlags
48
49 Next up we need to borrow a couple of binaries from [Cygwin](http://www.cygwin.com/). If you don't have Cygwin installed, please
50 install it including the `util-linux` package. Apart from `util-linux`'s dependencies, no other packages are required. When you
51 finished installation, copy the following files using msysgit's _Git Bash_. We assume the Cygwin's default installation path in C:\cygwin.
52
53 $ cd /c/cygwin/
54 $ cp bin/getopt.exe /usr/local/bin/
55 $ cp bin/cyggcc_s-1.dll /usr/local/bin/
56 $ cp bin/cygiconv-2.dll /usr/local/bin/
57 $ cp bin/cygintl-8.dll /usr/local/bin/
58 $ cp bin/cygwin1.dll /usr/local/bin/
ea738ef3 » jptoto
2010-08-20 Added installation instructions for Windows users
59
e26bfbc5 » agross
2010-11-02 Adding more detailed installation information for Windows users on Cy…
60 After copying the files above, you can safely uninstall your Cygwin installation by deleting the C:\cygwin directory.
ea738ef3 » jptoto
2010-08-20 Added installation instructions for Windows users
61
e26bfbc5 » agross
2010-11-02 Adding more detailed installation information for Windows users on Cy…
62 ### Manual installation
4f0f5391 »
2010-07-10 Added Rick Osborne's super-easy gitflow installer oneliner to the pro…
63 If you prefer a manual installation, please use the following instructions.
13c94821 »
2010-02-15 Added instructions to first fetch submodules before installing.
64 After downloading the sources from Github, also fetch the submodules:
65
66 $ git submodule init
67 $ git submodule update
68
69 Then, you can install `git-flow`, using:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
70
12c4ab4f »
2010-01-26 Update README file to mention new available features.
71 $ sudo make install
f206ba6c »
2010-01-26 Update README file to match the 0.1 release status.
72
e0b54c07 »
2010-03-19 Strip the GIT_EXEC_PATH Makefile parameter. Replaced it by the more U…
73 By default, git-flow will be installed in /usr/local. To change the prefix
74 where git-flow will be installed, simply specify it explicitly, using:
12c4ab4f »
2010-01-26 Update README file to mention new available features.
75
e0b54c07 »
2010-03-19 Strip the GIT_EXEC_PATH Makefile parameter. Replaced it by the more U…
76 $ sudo make prefix=/opt/local install
dd720bea »
2010-01-27 Dynamically collect the true git exec path and only if that can not b…
77
78 Or simply point your `PATH` environment variable to your git-flow checkout
79 directory.
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
80
b17b8986 »
2010-08-25 Add installation note on how to install getopt.
81 *Installation note:*
82 git-flow depends on the availability of the command line utility `getopt`,
83 which may not be available in your Unix/Linux environment. Please use your
84 favorite package manager to install `getopt`. For Cygwin, install the
47d1b9d7 »
2010-10-08 Made a note on the apt-get installer's package name.
85 `util-linux` package to get `getopt`. If you use `apt-get` as your install
86 manager, the package name is `opt`.
b17b8986 »
2010-08-25 Add installation note on how to install getopt.
87
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
88
ec0b854b »
2010-07-22 Add link to git-flow-completion project.
89 Integration with your shell
90 ---------------------------
25def71a »
2010-08-25 Mention the ZSH support for git-flow-completion.
91 For those who use the [Bash](http://www.gnu.org/software/bash/) or
92 [ZSH](http://www.zsh.org) shell, please check out the excellent work on the
ec0b854b »
2010-07-22 Add link to git-flow-completion project.
93 [git-flow-completion](http://github.com/bobthecow/git-flow-completion) project
94 by [bobthecow](http://github.com/bobthecow). It offers tab-completion for all
95 git-flow subcommands and branch names.
96
25def71a »
2010-08-25 Mention the ZSH support for git-flow-completion.
97 For Windows users, [msysgit](http://code.google.com/p/msysgit/) is a good
98 starting place for installing git.
ac949bfb » jptoto
2010-08-20 Fixed link to Cygwin and msysgit
99
ec0b854b »
2010-07-22 Add link to git-flow-completion project.
100
11965b32 »
2010-09-06 Added two FAQs.
101 FAQ
102 ---
61f2c691 »
2010-10-31 Fix FAQ link.
103 See the [FAQ](http://github.com/nvie/gitflow/wiki/FAQ) section of the project
104 Wiki.
cb922281 »
2010-09-22 Add FAQ note for Windows users.
105
11965b32 »
2010-09-06 Added two FAQs.
106
f206ba6c »
2010-01-26 Update README file to match the 0.1 release status.
107 Please help out
108 ---------------
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
109 This project is still under development. Feedback and suggestions are very
110 welcome and I encourage you to use the [Issues
111 list](http://github.com/nvie/gitflow/issues) on Github to provide that
f206ba6c »
2010-01-26 Update README file to match the 0.1 release status.
112 feedback.
113
d79a0d45 »
2010-04-04 Added referral link to the AUTHORS file.
114 Feel free to fork this repo and to commit your additions. For a list of all
115 contributors, please see the [AUTHORS](AUTHORS) file.
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
116
1fd5bcfe »
2010-07-15 Added link to Google group.
117 Any questions, tips, or general discussion can be posted to our Google group:
4d8b379a »
2010-08-19 Make the links manually.
118 [http://groups.google.com/group/gitflow-users](http://groups.google.com/group/gitflow-users)
1fd5bcfe »
2010-07-15 Added link to Google group.
119
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
120
5d1dbe74 »
2010-04-04 Added (BSD) licensing terms to the project.
121 License terms
122 -------------
123 git-flow is published under the liberal terms of the BSD License, see the
124 [LICENSE](LICENSE) file. Although the BSD License does not require you to share
125 any modifications you make to the source code, you are very much encouraged and
126 invited to contribute back your modifications to the community, preferably
127 in a Github fork, of course.
128
129
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
130 Typical usage:
131 --------------
b731e6f8 »
2010-08-19 Mention Jeff's great article on the README file.
132 For the best introduction to get started to `git flow`, please read Jeff
133 Kreeftmeijer's blog post:
134
4d8b379a »
2010-08-19 Make the links manually.
135 [http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/)
b731e6f8 »
2010-08-19 Mention Jeff's great article on the README file.
136
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
137
138 ### Initialization
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
139
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
140 To initialize a new repo with the basic branch structure, use:
12c4ab4f »
2010-01-26 Update README file to mention new available features.
141
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
142 git flow init
f9ebb076 »
2010-02-22 Added 'git flow init' to the README file.
143
c49c793a »
2010-02-24 Dotted i's and crossed t's in the README file, for release.
144 This will then interactively prompt you with some questions on which branches
145 you would like to use as development and production branches, and how you
146 would like your prefixes be named. You may simply press Return on any of
147 those questions to accept the (sane) default suggestions.
148
149
150 ### Creating feature/release/hotfix/support branches
12c4ab4f »
2010-01-26 Update README file to mention new available features.
151
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
152 * To list/start/finish feature branches, use:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
153
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
154 git flow feature
155 git flow feature start <name> [<base>]
156 git flow feature finish <name>
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
157
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
158 For feature branches, the `<base>` arg must be a commit on `develop`.
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
159
160 * To list/start/finish release branches, use:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
161
04839aef »
2010-01-28 Forgot list command for hotfixes.
162 git flow release
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
163 git flow release start <release> [<base>]
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
164 git flow release finish <release>
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
165
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
166 For release branches, the `<base>` arg must be a commit on `develop`.
167
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
168 * To list/start/finish hotfix branches, use:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
169
04839aef »
2010-01-28 Forgot list command for hotfixes.
170 git flow hotfix
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
171 git flow hotfix start <release> [<base>]
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
172 git flow hotfix finish <release>
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
173
174 For hotfix branches, the `<base>` arg must be a commit on `master`.
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
175
176 * To list/start support branches, use:
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
177
c81e7a2d »
2010-01-28 Update the README to reflect the new subcommand structure.
178 git flow support
010252a8 »
2010-02-04 Added an optional <base> argument to all start subactions.
179 git flow support start <release> <base>
180
181 For support branches, the `<base>` arg must be a commit on `master`.
78c73dc3 »
2010-01-21 Add initial project outline and guidelines.
182
b33ea8ac »
2010-08-24 Added a Flattr button to the README file.
183
184 Showing your appreciation
185 =========================
186 A few people already requested it, so now it's here: a Flattr button.
187
188 Of course, the best way to show your appreciation for the original
189 [blog post](http://nvie.com/git-model) or the git-flow tool itself remains
190 contributing to the community. If you'd like to show your appreciation in
191 another way, however, consider Flattr'ing me:
192
193 [![Flattr this][2]][1]
194
195 [1]: http://flattr.com/thing/53771/git-flow
196 [2]: http://api.flattr.com/button/button-static-50x60.png
Something went wrong with that request. Please try again.