C Project Starter

The C Project Starter is a command-line tool designed to streamline the process of starting new C projects. With just a few simple commands, you can create a basic project structure, complete with necessary files and folders.

For now, this project is compatible only with UNIX based operational systems

Prerequisites

• CMake
• Make
• Linux-based operating system

Installation

Easy Way

Just run the install script:

bash install.sh

Be sure that the ~/.local/bin/ dir is in your PATH!

Manual Way

1. Clone the repository to your local machine:

git clone [email protected]:ariasdiniz/c_project_starter.git

2. Navigate to the project directory:

cd c_project_starter

3. Build the project using CMake:

cmake .

4. Compile the project with Make:

make

5. (Optional) Add the executable to your system PATH for easier access:

cp cgen ~/.local/bin

Usage

To use the C Project Starter, follow these simple steps:

1. Open a terminal window.

2. Run the following command to generate a new C project:

cgen --name your_project_name -c 99

Replace your_project_name with the desired name for your project and 99 with the C version you want.

3. Once the command is executed, a new folder will be created in the current directory with the specified project name. Inside this folder, you will find the following files and folders:

• .gitignore: A file containing patterns to ignore when using Git version control.
• CMakeLists.txt: The CMake build script for your project.
• src/: A folder containing your project's source code files.
• lib/: A folder for any external libraries your project may depend on.
• include/: A folder for header files.
• main.c: A basic C source file to get you started.

Contributing

If you encounter any issues with the C Project Starter or have suggestions for improvements, please feel free to open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License.