File tree Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Original file line number Diff line number Diff line change @@ -26,6 +26,21 @@ installed as normal:
26
26
> The module utilities should support both Python 2 and 3 but we recommend
27
27
any modules/pipelines you write support both flavours.
28
28
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
+
29
44
## Running the test framework
30
45
> We plan to release the Python utility modules to [ PIP] at some stage. The
31
46
distribution is based on `setup.py` is present and works and will be
You can’t perform that action at this time.
0 commit comments