-
Notifications
You must be signed in to change notification settings - Fork 284
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
docs: Update README.md to include cmp submodule info #2323
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2323 +/- ##
==========================================
- Coverage 78.93% 78.92% -0.01%
==========================================
Files 127 127
Lines 24078 24078
==========================================
- Hits 19005 19004 -1
- Misses 5073 5074 +1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewable status: 1 change requests, 0 of 1 approvals obtained (waiting on @Tha14)
README.md
line 42 at r1 (raw file):
Detailed installation instructions can be found in [INSTALL.md](INSTALL.md). Be advised that due to the addition of `cmp` as a submodule, you now also need to initialize the git submodules required by toxcore. This can be done by cloning the repo with the addition of `--recurse-submodules` or by running `git submodule update --init` in the root directory of the repo.
What about including the full command to clone the c-toxcore repo: git clone --recurse-submodules https://github.com/Toktok/toxcore
, would make it easy to just copy paste
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: complete! 1 of 1 approvals obtained
README.md
line 42 at r1 (raw file):
Previously, sudden6 wrote…
What about including the full command to clone the c-toxcore repo:
git clone --recurse-submodules https://github.com/Toktok/toxcore
, would make it easy to just copy paste
Ok now
Might actually be a good idea since the rest of the process seems to go smoothly when cmp submodule is included.
This change is