This Bash script is designed to simplify the process of initializing C++ projects by creating a project directory structure, setting up necessary files like CMakeLists.txt, and installing dependencies with the configurations I prefer in my projects.
When starting a new C++ project, certain tasks are repetitive and time-consuming, such as creating directory structures, setting up build systems, and installing dependencies. This can be frustrating, especially when working on multiple projects. To streamline this process, I have created a script that automates the setup tasks, allowing developers to focus more on writing code and less on project setup.
As someone who regularly studies C++ and creates new projects, I understand the importance of being able to focus on the code rather than the project structure. That is why I created this script to automate the process of creating a new project.
- Create a project directory structure
- Generate CMakeLists.txt file
- By default sanitize and enable warnings in the CMakeLists.txt file
- Add a sample test file
Enabling sanitizers and warning flags in C++ offers significant benefits. Sanitizers detect common errors reducing security vulnerabilities. Warning flags promote best practices and code quality. By incorporating these tools, developers can enhance the security, reliability, and maintainability of their C++ codebases. Since sanitizers run at runtime, it is essential to have automated tests in the codebase.
This Bash script is provided as-is, without any warranty or guarantee of its suitability for any particular purpose. While the script aims to automate the setup process for C++ projects, it may not cover all possible scenarios or configurations.
Users are advised to review and understand the script's functionality before running it, and to use it at their own risk. The author and contributors of this script shall not be held responsible for any damages or issues that arise from the use of this script.
By using this script, you agree to indemnify and hold harmless the author and contributors from any liability, damage, or loss arising from its use.
- Clone the repository
git clone https://github.com/Fabio3rs/init_my_cpp_proj.git- Change the directory to the repository
cd init_my_cpp_proj- Make the script executable
chmod +x initcpp.sh- Add the script to the PATH
sudo cp initcpp.sh /usr/local/bin/initcppOR
cp initcpp.sh ~/.local/bin/initcppTo create a new C++ project, run the script with the project name as an argument. The script will create a new directory with the project name and set up the project structure and files.
initcpp <project-name>