c-template

Goal

To minimize the overhead in C development, and give a developer experience similar to Golang.

Introduction

c-template is a template repository intended to serve as a base layer for easier, and safer C development by encouraging best practices and providing well-tested components. It is intended to be used when starting a new C project by cloning the repository, and starting to work in the cloned repo, although you could copy the functionality into your respective libraries. It provides build management through CMake, unit testing with CMocka, dynamic analysis with Valgrind.

Doxygen is used for parsing your code comments turning it into docuementation with a single command. This encourages writing comments, updating those comments, and having always up to date documentation.

In additional to this, commonly used functionality is included to reduce the need for rewriting functionality in each new library.

Reusable Code

• thread safe logger ( logger.h )
  • color coded messages sent to stdout
  • optionally writes to a log file as well as sends to stdout
• array length and size checking ( array_len.h )
  • note: doesn't work properly on char* data types
• ansi color codes ( colors.h )
  • includes helper functions to created colored char*
  • can write to files as well
• random number and string generateion ( random.h )
• CLI template ( command_line.h )
  • example implementation in cli.c
• socket network tooling
  • utility functions, socket creation, and client usage ( socket.h )
  • socker server ( socket_server.h )

Usage

New Project

If starting a new project, the best way to use c-template is to clone the repo and use it as the base of your new project

Existing Project

If using an existing project, you'll probably want to juse copy & paste the code and configs in this repo. Eventually installation via make install in a manner that places the code into locations like /usr/include will eventually be done but is not there yet.

Examples

For now you'll want to look at the various *_test.c files. Eventually dedicated examples will be written.

etc...