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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 2 commits into from
Nov 7, 2024
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58d293a
fix, doc: we don't have to talk about submodules anymore
SGSSGene Nov 7, 2024
4b6b2aa
Merge branch 'main' into fix/README
SGSSGene Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -98,8 +98,7 @@ Quick-Setup without CMake:
g++-11 -O3 -DNDEBUG -Wall -Wextra \
-std=c++20 \
-I /path/to/seqan3/include \
-isystem /path/to/seqan3/submodules/sdsl-lite/include \
-isystem /path/to/seqan3/submodules/cereal/include \
-isystem /path/to/sdsl-lite/include \
-DSEQAN3_HAS_ZLIB=1 -DSEQAN3_HAS_BZIP2=1 \
-lz -lbz2 -pthread \
your_file.cpp
Expand Down
2 changes: 1 addition & 1 deletion doc/setup/library_tests/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Before submitting a pull request to our repository, make sure that the unit test

## Setting up unit tests

Assume that you have cloned SeqAn including submodules into `/home/me/devel/seqan3` and performed some local changes.
Assume that you have cloned SeqAn into `/home/me/devel/seqan3` and performed some local changes.

Create an out-of-source build directory and change to it:

Expand Down
10 changes: 2 additions & 8 deletions doc/setup/quickstart_cmake/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ hours of use per month, which is plenty for our tutorials. A GitHub account is r
- <b class="tab-title">Using GitHub Codespaces</b>
[GitHub Codespaces](https://github.com/codespaces) offer a service similar to gitpod, including a free monthly quota.
[Click here](https://codespaces.new/seqan/seqan3) to open SeqAn3 in Codespaces.
Please note that you may have to manually clone the submodules by running `git submodule update --init`.

</div>
<br>
Expand All @@ -104,13 +103,13 @@ tutorial
└── seqan3
```

To set these directories up you can follow this script (note the <b>\--recurse-submodules</b> when cloning SeqAn3):
To set these directories up you can follow this script:
```bash
mkdir tutorial
cd tutorial
mkdir build
mkdir source
git clone --recurse-submodules https://github.com/seqan/seqan3.git
git clone https://github.com/seqan/seqan3.git
```

The output of the command `tree -L 2` should now look like this:
Expand Down Expand Up @@ -230,11 +229,6 @@ target_link_libraries (my_app PUBLIC seqan3::seqan3)
```
and run `cmake` again.

* **SDSL library not found**: `The SDSL library is required, but wasn't found.`<br>
The repository was not cloned correctly. This can be verified by checking whether
`submodules/sdsl-lite/include/version.hpp` exists.
If it does not, try running `git submodule update --init` within the seqan3 directory.

* **Incorrect compiler**: `Your compiler is not supported.` or `Only GCC is supported.`<br>
The incorrect compiler is used (e.g., Apple Clang instead of GCC). Be sure to set `-DCMAKE_CXX_COMPILER=`. For an
example, see \ref remark_cmake_cxx_compiler "this remark".
Loading