Skip to content

Commit

Permalink
update README submodule instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rjleveque committed Jul 10, 2017
1 parent 8abba7b commit a91a0b5
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
This is a repository of applications of Clawpack and related software. Many of these examples are maintained as full-fledged examples that would be too large and/or complex to include in the individual repository examples. Also note that some of the applications are also maintained by people outside of the Clawpack developer team so questions should directed appropriately.

### Application Submodules
Some of the applications are included as git submodules of the main repository. This allows the responsible developers to maintain their application indepdent of the rest of the apps repository and lets users checkout only those apps that they are interested in. To fetch a submodule inside of the apps repository run
Some of the applications are included as git submodules of the main repository. This allows the responsible developers to maintain their application independent of the rest of the apps repository and lets users checkout only those apps that they are interested in. If you have already cloned the `apps` repository, then to fetch all submodules you can do the following:
```
$> cd $CLAW/apps
$> git submodule init
$> git submodule update
```
or more simply with a new enough version of `git`

The file `.gitmodules` contains a list of the submodules that will be fetched. Refer to the `git submodule` documentation for instructions on checking out only one submodule.

If you have not yet cloned the `apps` repository, you can clone it along with all the submodules via the following (with a new enough version of `git`):
```
$> cd $CLAW # (or you could put it elsewhere)
$> git clone --recursive https://github.com/clawpack/apps
```
Refer to the `git submodule` documentation for instructions on checking out only one submodule.

0 comments on commit a91a0b5

Please sign in to comment.