A minimalist project skeleton for C development. This repository provides a basic structure to set up C projects quickly and efficiently.

c-skeleton is a simple and minimalistic starting point for C projects. It includes the essential files and directory structure needed to begin developing C applications.

• Basic project structure
• Flexible Makefile for building the project
• Sample source files
• Directory setup for source, header, and test files

Ensure you have the following installed on your system:

• Standard C Compiler
• Make
• AWK (optional, for make help)
• fswatch (optional, for make watch)

Clone the repository to your local machine:

git clone --recurse-submodules https://github.com/jonruttan/c-skeleton.git
cd c-skeleton

To build the project, simply run:

make

For help on make options, run:

make help

To run all tests:

make test

To run a specific test:

TST=test/main.test.c make test

To watch files for changes:

make watch

To clean up the compiled files, use:

make clean

c-skeleton
├── include
│   ├── main.h
│   └── ...
├── src
│   ├── main.c
│   └── ...
├── test
│   ├── main.test.c
│   └── ...
├── .editorconfig
├── .gitignore
├── .gitmodules
├── CHANGELOG.md
├── LICENSE.md
├── Makefile
└── README.md

• include/: Contains the header files (.h files).
• src/: Contains the source files (.c files).
• test/: Contains the test files (.test.c files).
• .editorconfig: A file to define editor coding styles (https://editorconfig.org/).
• .git: Version control directory.
• .gitignore: Specifies intentionally untracked files to ignore.
• .gitmodules: Defines submodule properties.
• CHANGELOG.md: Changelog (https://keepachangelog.com/en/1.1.0/).
• LICENSE: License.
• Makefile: A file to automate the build process.
• README.md: This file.

Contributions are welcome! Please fork this repository and submit a pull request with your improvements.

This project is licensed under the MIT License - see the LICENSE file for details.