This project is a C project that utilizes a Makefile for building, running, and cleaning the project. It provides an organized file structure for the project, along with instructions on how to use the Makefile.
The project follows the following file structure:
project-name
│ README.md
│ Makefile
│ .gitignore
│ LICENSE
│
└───build
│ └───debug
│ └───release
│
└───src
│ ...
│
└───test
│ test.prr
| fibo.prr
|
└───logo
| cat.svg
README.md: Provides an overview of the project and instructions on how to use the Makefile.Makefile: Contains instructions for building, running, and cleaning the project..gitignore: Specifies files and directories to be ignored by Git.LICENSE: The Unlicense.build: Directory to store build artifacts.debug: Directory to store debug build artifacts.release: Directory to store release build artifacts.src: Directory to store source code files.test: Directory to store test cases.logo: Directory to store project logos or other related assets.
To use the Makefile, follow the steps below:
- Make sure you have
gccinstalled on your system. - Navigate to the project directory in the terminal.
To build the project, use the following command:
make [debug | release]
make debug: Builds the debug version of the project.make release: Builds the release version of the project.
The built executable will be placed in the respective build/debug or build/release directory.
To run the project, use the following command:
make run [ARGS="args"]
make run: Executes the debug version of the project.ARGS="args": Optional argument to pass command-line arguments to the program.
Example:
make run ARGS="arg1 arg2 arg3"
To clean the project and remove all build artifacts, use the following command:
make clean
This will remove the build directory and its contents.
If you encounter any issues or have suggestions for improvements, please feel free to contribute to the project by creating an issue or submitting a pull request.
This project is licensed under the Unlicense.