|
1 | | -# Git Flow Integration for Intellij |
2 | | - |
3 | | - |
4 | | -An intelliJ plugin providing a UI layer for git-flow, which in itself is a collection of Git extensions to provide high-level repository operations for Vincent [Driessen's branching model](http://nvie.com/git-model). |
5 | | - |
6 | | - |
7 | | - |
8 | | -## Supporting my work (so that the plugin doesn't die) |
9 | | - |
10 | | -Do you use this free software at work? Great! Would you like it to stay free? Of course you do. |
11 | | - |
12 | | -I'm not a Java developer. In fact, I don't even like Java. Still I've been actively supporting this plugin for the past 5+ years on my own free time. |
13 | | - |
14 | | -If saved you or your company time and effort, please consider supporting me by buying me a cup of coffee. |
15 | | -Better yet, get your boss to donate 10 cups. It's company money, they won't mind. |
16 | | - |
17 | | -[](https://ko-fi.com/R6R0TFS7) |
18 | | - |
19 | | -## Getting started |
20 | | - |
21 | | -For the best introduction to get started with `git flow`, please read Jeff Kreeftmeijer's blog post: |
22 | | - |
23 | | -[http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/) |
24 | | - |
25 | | -Or have a look at this [cheat sheet](http://danielkummer.github.io/git-flow-cheatsheet/) by Daniel Kummer: |
26 | | - |
27 | | -## Who and why |
28 | | - |
29 | | -This plugin was created by [Opher Vishnia](http://www.opherv.com), after I couldn't find any similar implementation. |
30 | | -I saw this [suggestion page](http://youtrack.jetbrains.com/issue/IDEA-65491) on the JetBrains site has more than 220 likes and 80 comments, and decided to take up the gauntlet :) |
31 | | - |
32 | | -Huge shoutout [to Kirill Likhodedov](https://github.com/klikh), who wrote much of the original git4idea plugin, without which this plugin could not exist |
33 | | - |
34 | | -## Installation |
35 | | - |
36 | | -The plugin is available via the IntelliJ plugin manager. Just search for "Git Flow Integration" to get the latest version! |
37 | | - |
38 | | -(The plugin requires that you have gitflow installed. I *highly* recommend using the [AVH edition](https://github.com/petervanderdoes/gitflow), rather than [Vanilla Git Flow](https://github.com/nvie/gitflow) since the original isn't being maintained anymore) |
39 | | - |
40 | | -**Mac/Linux users:** |
41 | | - |
42 | | -If you're running into issues like getting |
43 | | -`Gitflow is not installed` |
44 | | -or |
45 | | -`git: 'flow' is not a git command. See 'git --help'.` |
46 | | - |
47 | | -Please be sure to check out [this thread](https://github.com/OpherV/gitflow4idea/issues/7) |
48 | | - |
49 | | - |
50 | | -## Caveats |
51 | | - |
52 | | -While the plugin is operational and contains all basic functions (init/feature/release/hotfix), it may contains bugs. With your help I'll be able to find and zap them all. |
53 | | - |
54 | | -## Helping out |
55 | | - |
56 | | -This project is under active development. |
57 | | -If you encounter any bug or an issue, I encourage you to add the them to the [Issues list](https://github.com/OpherV/gitflow4idea/issues) on Github. |
58 | | -Feedback and suggestions are also very welcome. |
59 | | - |
60 | | -## License |
61 | | - |
62 | | -This plugin is under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0.html). |
63 | | -Copyright 2013-2018, Opher Vishnia. |
64 | | - |
65 | | - |
| 1 | +# Git Flow Integration for Intellij |
| 2 | + |
| 3 | + |
| 4 | +An intelliJ plugin providing a UI layer for git-flow, which in itself is a collection of Git extensions to provide high-level repository operations for Vincent [Driessen's branching model](http://nvie.com/git-model). |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +## Supporting my work (so that the plugin doesn't die) |
| 9 | + |
| 10 | +Do you use this free software at work? Great! Would you like it to stay free? Of course you do. |
| 11 | + |
| 12 | +I'm not a Java developer. In fact, I don't even like Java. Still I've been actively supporting this plugin for the past 5+ years on my own free time. |
| 13 | + |
| 14 | +If saved you or your company time and effort, please consider supporting me by buying me a cup of coffee. |
| 15 | +Better yet, get your boss to donate 10 cups. It's company money, they won't mind. |
| 16 | + |
| 17 | +[](https://ko-fi.com/R6R0TFS7) |
| 18 | + |
| 19 | +## Getting started |
| 20 | + |
| 21 | +For the best introduction to get started with `git flow`, please read Jeff Kreeftmeijer's blog post: |
| 22 | + |
| 23 | +[http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/) |
| 24 | + |
| 25 | +Or have a look at this [cheat sheet](http://danielkummer.github.io/git-flow-cheatsheet/) by Daniel Kummer: |
| 26 | + |
| 27 | +## Who and why |
| 28 | + |
| 29 | +This plugin was created by [Opher Vishnia](http://www.opherv.com), after I couldn't find any similar implementation. |
| 30 | +I saw this [suggestion page](http://youtrack.jetbrains.com/issue/IDEA-65491) on the JetBrains site has more than 220 likes and 80 comments, and decided to take up the gauntlet :) |
| 31 | + |
| 32 | +Huge shoutout [to Kirill Likhodedov](https://github.com/klikh), who wrote much of the original git4idea plugin, without which this plugin could not exist |
| 33 | + |
| 34 | +## Installation |
| 35 | + |
| 36 | +The plugin is available via the IntelliJ plugin manager. Just search for "Git Flow Integration" to get the latest version! |
| 37 | + |
| 38 | +(The plugin requires that you have gitflow installed. I *highly* recommend using the [AVH edition](https://github.com/petervanderdoes/gitflow), rather than [Vanilla Git Flow](https://github.com/nvie/gitflow) since the original isn't being maintained anymore) |
| 39 | + |
| 40 | +**Mac/Linux users:** |
| 41 | + |
| 42 | +If you're running into issues like getting |
| 43 | +`Gitflow is not installed` |
| 44 | +or |
| 45 | +`git: 'flow' is not a git command. See 'git --help'.` |
| 46 | + |
| 47 | +Please be sure to check out [this thread](https://github.com/OpherV/gitflow4idea/issues/7) |
| 48 | + |
| 49 | + |
| 50 | +## Caveats |
| 51 | + |
| 52 | +While the plugin is operational and contains all basic functions (init/feature/release/hotfix), it may contains bugs. With your help I'll be able to find and zap them all. |
| 53 | + |
| 54 | +## Helping out |
| 55 | + |
| 56 | +This project is under active development. |
| 57 | +If you encounter any bug or an issue, I encourage you to add the them to the [Issues list](https://github.com/OpherV/gitflow4idea/issues) on Github. |
| 58 | +Feedback and suggestions are also very welcome. |
| 59 | + |
| 60 | +## License |
| 61 | + |
| 62 | +This plugin is under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0.html). |
| 63 | +Copyright 2013-2019, Opher Vishnia. |
| 64 | + |
| 65 | + |
0 commit comments