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

fix, doc: we don't have to talk about submodules anymore #3301

Merged
merged 2 commits into from
Nov 7, 2024

Conversation

SGSSGene
Copy link
Contributor

@SGSSGene SGSSGene commented Nov 7, 2024

Since we are using CPM, we don't need to refer to submodules any more. I tried to remove all texts mentioning submodules.

@seqan-actions seqan-actions added lint [INTERNAL] signal for linting and removed lint [INTERNAL] signal for linting labels Nov 7, 2024
@seqan-actions
Copy link
Member

Documentation preview available at https://docs.seqan.de/preview/seqan/seqan3/3301

Copy link

codecov bot commented Nov 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.13%. Comparing base (eabcac1) to head (4b6b2aa).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3301   +/-   ##
=======================================
  Coverage   98.13%   98.13%           
=======================================
  Files         271      271           
  Lines       11948    11948           
  Branches      104      104           
=======================================
  Hits        11725    11725           
  Misses        223      223           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@eseiler eseiler self-requested a review November 7, 2024 10:52
@@ -88,7 +88,7 @@ We recommend that you use CMake to build your project:

Quick-Setup without CMake:

* Clone the repository with submodules: `git clone --recurse-submodules https://github.com/seqan/seqan3.git`
* Clone the repository: `git clone https://github.com/seqan/seqan3.git`
* Add the following to your compiler invocation:
* the include directories of SeqAn and its dependencies
* C++20 mode
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even want a non-CMake example on the readme?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly? no.... I wonder if this should be replaced via a CPM, add_subdirectory and/or a find_path example.

@seqan-actions seqan-actions added lint [INTERNAL] signal for linting and removed lint [INTERNAL] signal for linting labels Nov 7, 2024
Copy link
Member

@eseiler eseiler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep it like this for now and have a look at https://github.com/seqan/seqan3/tree/main/test%2Fexternal_project.
We can add a CPM example there and auto include it in the Readme.

@eseiler eseiler merged commit 3b4f644 into seqan:main Nov 7, 2024
42 checks passed
@SGSSGene SGSSGene deleted the fix/README branch November 7, 2024 19:33
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