Skip to content

Commit

Permalink
update submodule documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
KaiWaldrant committed Jul 4, 2024
1 parent 0e31cc0 commit 6900fb4
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
10 changes: 8 additions & 2 deletions INSTRUCTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,16 @@ A list of required software to start developing a new task can be found in the [

### `common` submodule

Initialize the `common` submodule by running the following command:
If the submodule does not show any files, you will need to initialize the `common` submodule by running the following command:

```bash
scripts/init_submodule.sh
git submodule update --init --recursive
```

To update the repository with the latest changes from in the submodule, you can run the following command:

```bash
git pull --recurse-submodules
```

## Resources
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@ The instructions below will guide you through creating a new repository from thi
* Set the repository visibility to public.
* Click "Create repository from template".

## Clone the repository

To clone the repository with the submodule files, you can use the following command:

```bash
git clone --recurse-submodules [email protected]:openproblems-bio/<repo_name>.git
```


## What to do next

Check out the [instructions](INSTRUCTIONS.md) for more information on how to update the example files and components. These instructions also contain information on how to build out the task and basic commands.
Expand Down
3 changes: 0 additions & 3 deletions scripts/init_submodule.sh

This file was deleted.

0 comments on commit 6900fb4

Please sign in to comment.