ni / ni/nilrt-docs

CMakeLists.txt should not go in the build folder, instead it should go in the project root.

Open
#31 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
8
Forks
26
PR merge metrics
No merged PRs in 30d

Description

image

Typically the build folder is ephemeral and shouldn't include files that should get checked into SCC. The CMakeLists.txt should instead be placed in the project root and then a build folder can be made and from within that cmake .. can be run or the cmake extension for VS Code can be configured to look at the project root and then put cmake configuration output in build.

This will then also impact later steps and how they refer to source paths.

Contributor guide

Open the contributing guide

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.

Research direction

Start by locating the current CMakeLists.txt in the build folder and reviewing the later steps that refer to source paths. Check the CMake and VS Code instructions, then verify that configuration can run from a separate build folder with cmake .. and that subsequent paths remain correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, vscode
Domain
build-system, documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.