C Project Template

Description

C Project Template is a minimal template for starting new C projects. It provides a simple "Hello World" program, a compile-and-run script, and a VS Code dev container configuration to get you up and running quickly.

Installation

1. Click Use this template on the GitHub repository page to create a new repository from this template, or clone it directly:

   git clone https://github.com/Stephenson-Software/c-project-template.git
   

2. Ensure you have gcc installed on your system.
3. Compile the project:

   gcc projectTemplate.c -o projectTemplate.exe
   

4. Run the compiled program:

   ./projectTemplate.exe
   

Usage

Documentation

• User Guide – Getting started and common scenarios
• Commands Reference – Build and run commands
• Configuration Guide – Project configuration options

Support

Experiencing a bug?

Please fill out a bug report here.

• Known Bugs

Contributing

• CONTRIBUTING.md

Testing

Building and Running

Linux / macOS:

gcc projectTemplate.c -o projectTemplate.exe
./projectTemplate.exe

Windows (with MinGW or similar):

gcc projectTemplate.c -o projectTemplate.exe
projectTemplate.exe

If you see Hello World! printed to the console, the build was successful.

Development

Dev Container

A VS Code dev container is provided for development.

Setup

1. Install Docker Desktop and VS Code.
2. Install the Dev Containers extension.
3. Open the repository in VS Code.
4. When prompted, click Reopen in Container (or run the command Dev Containers: Reopen in Container).

Compile and Run Script

Use the provided cr.sh script to compile and run in one step:

./cr.sh

Authors and Acknowledgement

Developers

Name	Main Contributions
Daniel McCoy Stephenson	Creator and maintainer

License

This project is licensed under the Stephenson Software Non-Commercial License (Stephenson-NC).

See the LICENSE file for full details.

Project Status

This project is in active development as a template for new C projects.