Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
updated instructions for submodule recursing during initial clone
  • Loading branch information
markusbattarbee authored Aug 27, 2024
1 parent 62ac639 commit 52f942a
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ In Vlasiator, ions are represented as velocity distribution functions, while ele
Due to the multi-dimensional approach at ion scales, Vlasiator's computational challenges are immense. We use advanced high performance computing techniques to allow massively parallel computations on tens of thousands of cores.

## git submodules
We are transferring to use `git submodules` for the dependent libraries. Some of the header libraries have already been moved to this framework. Thus, we recommend to use the `--recurse-submodules` option when cloning, pulling, or checking out branches.
We are transferring to use `git submodules` for the dependent libraries. Some of the header libraries have already been moved to this framework. Thus, we recommend to use the `--recurse-submodules` option when pulling or checking out branches.

For first-time cloning, the following is required in order to initialize submodules correctly:
```
git clone --recurse-submodules https://github.com/fmihpc/vlasiator
git checkout <branch> --recurse-submodules
git checkout <branch>
git submodule update --init --recursive
```

Expand Down

0 comments on commit 52f942a

Please sign in to comment.