Skip to content

Commit daeda9e

Browse files
committed
Update documentation
1 parent a61de44 commit daeda9e

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Git-Matrix
22

3-
Script to manage Git projects with multiple submodules and multiple branches per repository.
3+
Script to manage Git projects with multiple submodules and multiple environment branches per repository.
44

5-
## What is Git-Matrix?
5+
## What is a Git-Matrix?
66

7-
If you have several initialized submodules in your project, and you handle several branches both in the project as in the related submodules, then you have a Git-Matrix case:
7+
If you have several initialized submodules in your project, and you handle several environment branches both in the project as in the related submodules, then you have a Git-Matrix case:
88

99
-------------------------------------
1010
| B | B | B | B | | B |
@@ -29,3 +29,10 @@ If you have several initialized submodules in your project, and you handle sever
2929
-------------------------------------------------------------
3030

3131
## How does it work?
32+
33+
The git_matrix.sh script works in the following way:
34+
35+
* You directly move across the project environment branches using the usual Git commands such as `git checkout <branch>` or any other similar.
36+
* Being positioned at the branch you want to update, you can directly run the `./bin/git_matrix.sh` script from the project root folder, witch in a first step updates the active local branch (`git pull`) and submodules status (`git submodule init` & `git submodule update`).
37+
* If the active branch is the environment branch defined in the first position, the script directly do the following actions:
38+
*

0 commit comments

Comments
 (0)