Skip to content

Files

Latest commit

 

History

History
38 lines (30 loc) · 2.76 KB

README.md

File metadata and controls

38 lines (30 loc) · 2.76 KB

C scaffolding structure

Scaffolding structure for C projects and custom Makefile
Use this template for your own projects 😊


Requirements 🧾

  • gcc compiler or another compiler for C
  • make library to run Makefile
  • Git Bash (you need some linux commnads so you cant use this with cmd or other terminal)
  • 🧠

Installation and first run 🐱

  • clone repozitory git clone https://github.com/FrantisekSpunda/C-scaffolding.git
  • got to project folder cd c-scaffolding
  • run make init to create config.cfg file
  • edit config.cfg as needed
  • run make all (or make build and make run)

Usage 🐔

Using makefile you can run commands for compilation, generating headers and new modules etc.

Command Description
help / list Show all available commands you can use and their description.
init Create project configuratin file.
build / compile Compile C program in src.
run Run your compiled C program.
all Compile and run your C program.
clear / clean Remove build folder.
header Update or create header in all .c files. In header is your name, copyright and last update of file.
module Create new module for C. With this command you will create C module with custom name. In files there will be generated required content that is usualy in all C libraries 👌.