sillsdev / languageforge-lexbox

Language Forge / Language Depot unification project
MIT License
6 stars 2 forks source link

README needs to mention `git clone --recurse-submodules` #848

Open rmunn opened 1 month ago

rmunn commented 1 month ago

Now that we're using submodules, the README.md file needs to mention the need to run git clone --recurse-submodules when checking out the repository, otherwise task up fails because the Crdt classes can't be found.

The README should also mention that existing repos that were cloned without --recurse-submodules need to run git submodule init followed by git submodule update --recursive.

hahn-kev commented 1 month ago

You know it would probably be easier to just run those submodule commands as part of task setup