Example: How to depend on GE211 in a subdirectory

This repo contains a minimal, complete example of how a project can depend on GE211 in a subdirectory, rather than by installing it on your system. The CMakeLists.txt expects 3rdparty/ge211/ to be (linked to) a subdirectory containing the GE211 library. For the purposes of testing, we assume that we check out this repo as a submodule of the GE211 repository at examples/vendored/, and ge211 is a symbolic link to ../../../.

There are two strategies to replace the symlink with a copy of GE211 that doesn’t depend on the context of this repository: You can add a submodule reference or copy GE211’s code directly into your repository.

(Note that src/fw.cxx is also a symlink to an example program in the vendored GE211 subdirectory.)

Including GE211 by reference

To include a reference to GE211, you should remove the symlink and add it as a Git submodule instead:

user@host repo% cd 3rdparty
user@host 3rdparty% git rm ge211
user@host 3rdparty% git submodule add https://github.com/tov/ge211.git
user@host 3rdparty% git commit -m 'Added GE211 as submodule'

Including GE211 by value

To include a copy of GE211, you should remove the symlink, clone the repository, remove its .git/ directory, and then add it to your own repository:

user@host repo% cd 3rdparty
user@host 3rdparty% git rm ge211
user@host 3rdparty% git clone https://github.com/tov/ge211.git
user@host 3rdparty% rm -Rf ge211/.git
user@host 3rdparty% git add ge211
user@host 3rdparty% git commit -m 'Vendored GE211'