Skip to content

Commit

Permalink
Merge pull request #144 from TeaganKing/externals_documentation
Browse files Browse the repository at this point in the history
Update README.md to include note on git submodule 'gotcha'
  • Loading branch information
TeaganKing authored Oct 16, 2024
2 parents 54de63c + 530fe92 commit 92b0c30
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ It still feels slower than running `mamba` directly, hence the recommendation to
If you do not have `mamba` installed, you can still use `conda`... it will just be significantly slower.
(To see what version of conda you have installed, run `conda --version`.)
1. If the subdirectories in `externals/` are all empty, run `git submodule update --init` to clone the submodules.
1. For existing users who cloned `CUPiD` prior to the switch from manage externals to git submodule, we recommend removing `externals/` before checking out main, running `git submodule update --init`, and removing `manage_externals` (if it is still present after `git submodule update --init`).
1. If `which cupid-run` returned the error `which: no cupid-run in ($PATH)`, then please run the following:

``` bash
Expand Down

0 comments on commit 92b0c30

Please sign in to comment.