search

alterNERDtive / elite-scripts

A collection of useful scripts around Elite: Dangerous
https://git.alternerd.tv/EliteDangerous/elite-scripts
GNU General Public License v3.0
12 stars 4 forks source link

added details about submodules usage #1

Closed mbravorus closed 1 year ago

alterNERDtive commented 4 years ago

git submodule update --remote is actually not the thing you want to use. It sets the submodule working copy to the remote-tracking branch.

What you actually need to do is git fetch from within the submodule, then run a git submodule update on the main repo.

As long as there are no compatibility-breaking changes on the submodule remote, both work fine though.

Oh and if you clone the repo with --recursive initially, it will clone the submodules, too :)

mbravorus commented 4 years ago

If you are just a user, you probably want exactly the remote tracking branch. and for people who want to contribute, there's usually some kind of CONTRIBUTING.md :)

Ultimately, I wanted to add a minimum set of instructions for an arbitrary user to get the tools working. Happy to amend the way you see it best.

alterNERDtive commented 4 years ago

If you are just a user, you probably want exactly the remote tracking branch

See, that’s not true. Right now it’s ahead of the commit used here, for example. Now that should not break it, but won’t be guaranteed not to.

And if you are “just a user”, you probably just want to grab a release anyway (incidentally there now is one).

alterNERDtive commented 4 years ago

I guess I’m just going to add something pointing people to the releases page …