Refactor Week 1

Open
#100 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
cmake, cpp

Research direction

No files, tests, or entry points are named; start from the Week 1 requirements in this issue. Define the introductory slides, a guided CMake project and exercises for a realistic research project, plus Catch2 header-only and FindModules examples. Done means the planned teaching materials and examples are produced.

Written by the indexing model from the issue text.

Description

Will need traditional slides or some kind of intro/motivation without much background reading.

  • Guided interactive example of CMake where instructor runs through a basic project.
    Krishna to provide CMake exercises for a realistic type of research project (without testing)

  • Unit Testing aspects with Catch2 header-only
    Krishna will produce CMake examples using the FindModules feature

Dominant language
Ruby
Stars
31
Forks
20
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from UCL/research-computing-with-cpp

All issues in UCL/research-computing-with-cpp

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.