Submodules do not init by default when first cloning the repository

[frozenfrank]

Overview

The example demonstrated in this repo with the submodule organization is incompatible with the build commands for the phase. Introducing submodules into the project create complexities in the cloning process that are not accounted for in the standard grading procedure.

The course example and the instructions need to be reconciled to be compatible with each other; alternatively, the instructions should be make more clear that the grader will load submodules as necessary.

One potential solution is to just copy the file into the project without dealing with the complexities of submodules.

Discussion

Specifically, in the Phase 2 Submission instructions-,Submission%3A%20Git,-You%E2%80%99ll%20submit%20your), the following command sequence is given:

git clone <yournetid>@homework.rc.byu.edu:scicomp
cd scicomp
git checkout phase2
module load gcc/14.1 cmake catch2
mkdir bld
cd bld
cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
cmake --build . --parallel

The first command git clone will not download content of the submodules properly (it only creates an empty directory). In the documentation, there is a --recurse-submodules flag that should do the trick. When I tried the command, I got an error potentially related to public key permissions?

Screenshots

1. Simply cloning the project results in no content for the required subdirectories.

2. Recursively cloning the project runs into a permission issue when loading the submodule.