Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md to update submodules when cloning the repository #289

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

notraceofsense
Copy link

@notraceofsense notraceofsense commented Feb 28, 2024

Updated git clone command examples to use --recurse-submodules

Mark the type contribution you are making:

  • Documentation change (no change to underlying code, but makes documentation a little simpler)

Description

I replaced the three separate git clone, cd Delta, and git submodule commands with a --recurse-submodules option, which is equivalent. This removes a potential hiccup in getting ready to work with the codebase of forgetting to initialize the submodules.

Testing

Ran the command in question and it did the same thing as the current set of commands.

Checklist

General (All PRs)

  • [N/A] My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • [N/A] I have commented my code, particularly in hard-to-understand areas
  • [N/A] My changes generate no new warnings
  • [N/A] I've tested my changes with different device + OS version configurations

Updated git clone command examples to use --recurse-submodules
grammatical fix
@grndng
Copy link

grndng commented Apr 25, 2024

Before merging this I'd recommend to merge #145 because the submodules can not be accessed with SSH and @katagaki has modified the .gitmodules file already.

@jaimegarjr
Copy link

Thanks for working on this! This would have been useful to know when setting up my local dev env.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants