/c-cpp-notes

Lecture notes and example code for teaching C & C++

Primary LanguagePython

C & C++ programming notes

License: CC BY 4.0

  • Author: Ben Langmead

These are lecture notes and example code for teaching C & C++. The slides themselves are written in a custom "runnable Markdown" dialect for C/C++. These files have extension .cppmd. The script that "compiles" .cppmd files is units/cppmd_render.py. This script:

  • Generates C/C++ source files based on specially-formatted comments in the Markdown (<!---cppmd-file ... -->)
  • Runs shell commands based on specially-formatted comments in the Markdown (<!---cppmd-shell ... -->), often in order to compile and run the source code
    • Possibly integrates the output from the shell back into the slides, so that output can be included in final rendered doc
  • Uses pandoc & beamer to render a PDF

Outputs consist of (a) a PDF of the slides, (b) source files for all the examples.

All the shel commands are run within a Docker image. We use this image from Docker Hub:

And the corresponding Dockerfile and scripts used to build/pull/push are available in the docker subdirectory. The base image is Fedora 27. The most relevant software versions are:

gcc-7.2.1
g++-7.2.1
gdb: Fedora 8.0.1-33.fc27
valgrind-3.13.0
git v2.14.3