Skip to content

Commit 3ee8434

Browse files
author
Martin Mosegaard Amdisen
committed
close #182 cleanup the documentation of wrapup
1 parent ba847d3 commit 3ee8434

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,14 @@ brew tap praqma/praqma-tap
4444
brew install git-phlow
4545
```
4646
### Linux
47-
You can also install git-phlow running the following commands. That will download and install the project.
48-
Remember to use the latest version.
47+
Install git-phlow running the following commands. Remember to use the latest version.
4948

5049
```shell
51-
#For linux
5250
wget https://github.com/Praqma/git-phlow/releases/download/v2.3.2/git-phlow-2.3.2-linux-amd64.tar.gz && tar -xzf git-phlow-2.3.2-linux-amd64.tar.gz && mv git-phlow /usr/local/bin
5351
```
5452

5553
### Windows
56-
git-phlow can be install with [scoop](http://scoop.sh/), a package manager for command line tools. It can also be install by downloading the latest [release]((https://github.com/Praqma/git-phlow/releases))
54+
Install with [scoop](http://scoop.sh/), a package manager for command line tools. Or download the latest [release]((https://github.com/Praqma/git-phlow/releases))
5755

5856
**Install Scoop**
5957

@@ -92,23 +90,21 @@ git phlow workon 42
9290

9391
- This will create a branch: `42-some-issue-title`
9492
- Make the changes and complete the task
95-
- When it's done, type:
93+
- When done, add everything and commit with a single command:
9694

9795
```git
9896
git phlow wrapup
99-
100-
#adds everything and commits the changes
101-
#alternately you can add your changes manually and use
102-
git phlow wrapup
10397
```
98+
10499
- Now that the changes are ready, type:
105100

106101
```git
107102
git phlow deliver
108-
# renames local branch to: delivered/42-some-issue-title
109-
# pushes remote branch named: ready/42-some-issue-title
110103
```
111104

105+
- It renames the local branch to: `delivered/42-some-issue-title`
106+
- It pushes remote branch named: `ready/42-some-issue-title`
107+
112108
If the automation tools have been configured to listen for __ready/__ branches, they will pick up the branch and integrate them with the stable branch.
113109
If you do not have an automation system, you can deliver the work to your default branch by doing a local deliver instead.
114110

@@ -117,7 +113,7 @@ git phlow deliver --local
117113
```
118114

119115
- Changes branch to `master`
120-
- Merges changes from `42-some-issue-branch`
116+
- Merges changes from `42-some-issue-title`
121117
- Pushes changes to GitHub
122118

123119
### Automation systems

0 commit comments

Comments
 (0)