Skip to content

Commit

Permalink
#9 - lint only on demand
Browse files Browse the repository at this point in the history
  • Loading branch information
thorstendikmann committed Mar 28, 2024
1 parent 69b12de commit 6235098
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
6 changes: 2 additions & 4 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
name: CMake on a single platform

# Only start manually
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
workflow_dispatch:

env:
BUILD_TYPE: Release
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,22 @@ cd ~ && npm install doctoc
- [Clone Repository](#clone-repository)
- [Local Build Requirements](#local-build-requirements)
- [Local Build Execution](#local-build-execution)
- [Add own source code](#add-own-source-code)
- [Add own source code (from scratch)](#add-own-source-code-from-scratch)
- [Work on exercises (from "snippets")](#work-on-exercises-from-snippets)
- [Integrated Development Environment](#integrated-development-environment)
- [Running CMake in Visual Studio Code](#running-cmake-in-visual-studio-code)
- [Running Programs in VS Code](#running-programs-in-vs-code)
- [Interacting with the repository](#interacting-with-the-repository)
- [Cleaning the build folder](#cleaning-the-build-folder)
- [Getting updates](#getting-updates)
- [Reverting local changes](#reverting-local-changes)
- [Integrated Development Environment](#integrated-development-environment)
- [Running CMake in Visual Studio Code](#running-cmake-in-visual-studio-code)
- [Running Programs in VS Code](#running-programs-in-vs-code)
- [Optional parts](#optional-parts)
- [Recommended addons](#recommended-addons)
- [Boost](#boost)
- [GoogleTest](#googletest)
- [Doxygen](#doxygen)
- [Valgrind](#valgrind)
- [cppchecker](#cppchecker)
- [cppcheck](#cppcheck)
- [Docker-based Build Environment](#docker-based-build-environment)
- [Installing Docker](#installing-docker)
- [Building and Executing](#building-and-executing)
Expand Down Expand Up @@ -292,7 +293,7 @@ apt-get install valgrind
valgrind bin/hello/hello_world_c
```

#### cppchecker
#### cppcheck

Additional static code analysis tool to detect potential issues with the source code.

Expand All @@ -306,6 +307,7 @@ cppcheck src --force
cppcheck src --force --enable=all --suppress=unusedFunction --suppress=redundantAssignment --suppress=variableScope --suppress=missingInclude --inline-suppr --template=gcc
```

<!--
#### Visualization
- For compiling and running the GUI examples, the following is needed:
Expand All @@ -317,6 +319,7 @@ apt-get install qt6-base-dev
```sh
cmake .. -DWITH_VIS=ON
```
-->

### Docker-based Build Environment

Expand Down

0 comments on commit 6235098

Please sign in to comment.