Skip to content

Commit

Permalink
Clarify submodules in desktop_version/README.md
Browse files Browse the repository at this point in the history
VVVVVV uses submodules now, so you need to know how to initialize them.

I'm explicitly not including `git clone --recurse-submodules`. Usage of
submodules in git projects is kinda rare in my experience, so people
are used to doing simple clones, and that instruction would just result
in people being annoyed thinking they have to delete the repo they
already cloned, and clone it again except slightly differently.

It also doesn't help you if you need submodules that aren't in the
master branch (for example, if you clone my fork recursively and then
checkout the localization branch, you won't have C-HashMap and you'll
need the update command anyway). And you also need it whenever VVVVVV
updates its submodules. So teaching people just the update command is
better.
  • Loading branch information
Daaaav authored and InfoTeddy committed Oct 16, 2022
1 parent d69c88e commit 2d6b2e6
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions desktop_version/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ respective repositories, and macOS developers should compile and install from so
[see here](https://github.com/TerryCavanagh/VVVVVV/issues/618#issuecomment-968338212)
for workarounds.)

Since VVVVVV 2.4, git submodules are used for the
[third party libraries](https://github.com/TerryCavanagh/VVVVVV/tree/master/third_party).
After cloning, run `git submodule update --init` to set all of these up.
You can also use this command whenever the submodules need to be updated.

Steamworks support is included and the DLL is loaded dynamically, you do not
need the SDK headers and there is no special Steam or non-Steam version. The
current implementation has been tested with Steamworks SDK v1.46.
Expand Down

0 comments on commit 2d6b2e6

Please sign in to comment.