Skip to content

Commit 3b4f644

Browse files
authored
Merge pull request #3301 from SGSSGene/fix/README
fix, doc: we don't have to talk about submodules anymore
2 parents eabcac1 + 4b6b2aa commit 3b4f644

File tree

3 files changed

+5
-12
lines changed

3 files changed

+5
-12
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ We recommend that you use CMake to build your project:
8888

8989
Quick-Setup without CMake:
9090

91-
* Clone the repository with submodules: `git clone --recurse-submodules https://github.com/seqan/seqan3.git`
91+
* Clone the repository: `git clone https://github.com/seqan/seqan3.git`
9292
* Add the following to your compiler invocation:
9393
* the include directories of SeqAn and its dependencies
9494
* C++20 mode
@@ -98,8 +98,7 @@ Quick-Setup without CMake:
9898
g++-11 -O3 -DNDEBUG -Wall -Wextra \
9999
-std=c++20 \
100100
-I /path/to/seqan3/include \
101-
-isystem /path/to/seqan3/submodules/sdsl-lite/include \
102-
-isystem /path/to/seqan3/submodules/cereal/include \
101+
-isystem /path/to/sdsl-lite/include \
103102
-DSEQAN3_HAS_ZLIB=1 -DSEQAN3_HAS_BZIP2=1 \
104103
-lz -lbz2 -pthread \
105104
your_file.cpp

doc/setup/library_tests/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Before submitting a pull request to our repository, make sure that the unit test
1919

2020
## Setting up unit tests
2121

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

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

doc/setup/quickstart_cmake/index.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ hours of use per month, which is plenty for our tutorials. A GitHub account is r
8181
- <b class="tab-title">Using GitHub Codespaces</b>
8282
[GitHub Codespaces](https://github.com/codespaces) offer a service similar to gitpod, including a free monthly quota.
8383
[Click here](https://codespaces.new/seqan/seqan3) to open SeqAn3 in Codespaces.
84-
Please note that you may have to manually clone the submodules by running `git submodule update --init`.
8584

8685
</div>
8786
<br>
@@ -104,13 +103,13 @@ tutorial
104103
└── seqan3
105104
```
106105

107-
To set these directories up you can follow this script (note the <b>\--recurse-submodules</b> when cloning SeqAn3):
106+
To set these directories up you can follow this script:
108107
```bash
109108
mkdir tutorial
110109
cd tutorial
111110
mkdir build
112111
mkdir source
113-
git clone --recurse-submodules https://github.com/seqan/seqan3.git
112+
git clone https://github.com/seqan/seqan3.git
114113
```
115114

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

233-
* **SDSL library not found**: `The SDSL library is required, but wasn't found.`<br>
234-
The repository was not cloned correctly. This can be verified by checking whether
235-
`submodules/sdsl-lite/include/version.hpp` exists.
236-
If it does not, try running `git submodule update --init` within the seqan3 directory.
237-
238232
* **Incorrect compiler**: `Your compiler is not supported.` or `Only GCC is supported.`<br>
239233
The incorrect compiler is used (e.g., Apple Clang instead of GCC). Be sure to set `-DCMAKE_CXX_COMPILER=`. For an
240234
example, see \ref remark_cmake_cxx_compiler "this remark".

0 commit comments

Comments
 (0)