Skip to content

Commit f22d62d

Browse files
author
Alan Christie
committed
- Added note about creating new projects in the README
1 parent 35d42a8 commit f22d62d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,21 @@ installed as normal:
2626
> The module utilities should support both Python 2 and 3 but we recommend
2727
any modules/pipelines you write support both flavours.
2828

29+
## Adding this project as a submodule for a new pipelines project
30+
If you have started a new pipelines project you can add these utilities
31+
to it by running the following from the project root of your new project: -
32+
33+
$ git submodule add https://github.com/InformaticsMatters/pipelines-utils.git
34+
35+
This will create a new directory (`pipelines-utils`) and a `.gitmodules` file.
36+
You must add the `.gitmodules` to your project. Read about the Git [Submodule]
37+
for more information.
38+
39+
If you checkout a new working copy you will need to initialise the submodule
40+
with the command: -
41+
42+
$ git submodule update --init --remote
43+
2944
## Running the test framework
3045
> We plan to release the Python utility modules to [PIP] at some stage. The
3146
distribution is based on `setup.py` is present and works and will be

0 commit comments

Comments
 (0)