Skip to content

docs: Update README.md to include cmp submodule info#2323

Merged
sudden6 merged 1 commit into
TokTok:masterfrom
Tha14:patch-1
Jun 22, 2022
Merged

docs: Update README.md to include cmp submodule info#2323
sudden6 merged 1 commit into
TokTok:masterfrom
Tha14:patch-1

Conversation

@Tha14
Copy link
Copy Markdown

@Tha14 Tha14 commented Jun 20, 2022

Might actually be a good idea since the rest of the process seems to go smoothly when cmp submodule is included.


This change is Reviewable

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 20, 2022

Codecov Report

Merging #2323 (2d04c41) into master (9a26580) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 2d04c41 differs from pull request most recent head 32ed67c. Consider uploading reports for the commit 32ed67c to get more accurate results

@@            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     
Impacted Files Coverage Δ
auto_tests/tox_many_test.c 98.18% <0.00%> (-1.82%) ⬇️
toxcore/friend_connection.c 82.83% <0.00%> (-0.70%) ⬇️
toxcore/net_crypto.c 87.13% <0.00%> (-0.23%) ⬇️
toxcore/group.c 84.41% <0.00%> (-0.07%) ⬇️
toxcore/DHT.c 83.94% <0.00%> (ø)
toxcore/onion.c 85.51% <0.00%> (ø)
toxcore/TCP_server.c 78.58% <0.00%> (+0.18%) ⬆️
toxav/toxav.c 69.37% <0.00%> (+0.29%) ⬆️
toxav/groupav.c 75.91% <0.00%> (+1.33%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9a26580...32ed67c. Read the comment docs.

@Tha14 Tha14 changed the title Update README.md to include cmp submodule info docs: Update README.md to include cmp submodule info Jun 20, 2022
@auto-add-label auto-add-label Bot added the documentation Changes to the documentation label Jun 20, 2022
Copy link
Copy Markdown

@sudden6 sudden6 left a 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

Copy link
Copy Markdown

@sudden6 sudden6 left a 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: :shipit: 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

@sudden6 sudden6 added this to the v0.2.19 milestone Jun 22, 2022
@sudden6 sudden6 merged commit 32ed67c into TokTok:master Jun 22, 2022
@Tha14 Tha14 deleted the patch-1 branch September 29, 2022 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes to the documentation

Development

Successfully merging this pull request may close these issues.

2 participants