stevengogogo / cprojecttemplate

Project template for C programming. Including debugging in VSCODE, makefile and Unit testing

Hi there 👋

I am currently a Ph.D. student of Electrical Engineering at Texas A&M University.

• Here is my latest CV: CV_ShaoTingChiu.pdf
• My personal website: Resume.io

Languages

C, Julia, Python, Latex

cprojecttemplate's Issues

Use TEST_CHECK not TEST_ASSERT for unittesting

https://github.com/mity/acutest/blob/aadfc558f02610159e371a9ab2a673dc289c9fd5/examples/c-example.c#L49

 /* Kill the current test with a condition which is never true. */
    TEST_ASSERT(1 == 2);

    /* This never happens because the test is aborted above. */
    TEST_CHECK(1 + 2 == 2 + 1);

Tutorial of this template

Features

• Clear structures
  • Source and test
  • Header file are organized under src/include/
  • Building with makfile
• Unit testing
  • Organized by runtests.c
  • Use [acutest.h] (test/acutest.h) debugging (Courtesy from mity/acutest)
• Debugger with VScode
  • The configuration of debugger are supported under .vscode

Prerequist

1. Vscode
2. build-essentials
3. Linux

How to use this C template

Build and Run with src/main.c

make BUILD_RUN

Unit testing

make TEST

Set workspace to this project

Use the debugger icon on VScode

Setup CD: Continuous Documentation

C Documentation with Doxgen

https://medium.com/@satviksr/automatically-publish-documentation-of-your-code-using-github-actions-and-doxygen-e9aaa75f6347

Use gdb with MacOS

https://www.ics.uci.edu/~pattis/common/handouts/macmingweclipse/allexperimental/mac-gdb-install.html

Remove executables in build folder

Because they are not needed anyway.

tput is not found on Github CI

Add Github CI

Success condition

https://github.com/stevengogogo/CProjectTemplate/actions/runs/616278717

Failed condition

https://github.com/stevengogogo/CProjectTemplate/runs/2018927090