/CMakeCLI

Primary LanguageShellGNU Affero General Public License v3.0AGPL-3.0

About CMake CLI Tools

Purpose: This is a project with a set scripts to help automate the creation of CMake projects for C/C++ software development. Also these tools are an attempt to help ease the handling the project as it grows in size and evolves.

Getting Started

Prerequisites

Dependencies need to be installed before being about to use the tools locally in your computer.

Installation

To install the bash versions of the tools follow the steps below

  1. clone repo to your machine
    git clone https://github.com/fonzg1/CMake_cli_tools.git
  2. run the following script to add tools to your PATH
    bash setup_scripts2path
    

Usage

TODO

Project Docs & Specs

  1. To understand how use the tools go to docs and read the files created to guide you through the usage of these tools.

  2. If you want to know how this project is structured please read and review the specs files

Roadmap

  • Add project specifications
  • Add bash script to automate installation
  • [] Add Changelog
  • [] Add git ignore file
  • [] Add User guide
  • [] Create a Wiki

Contributing

If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your feature Branch (git checkout -b feature/AwesomeFeature)
  3. Commit your changes (git commit -m 'Add some AmesomeFeature comments')
  4. Push to the Branch (git push origin feature/AwesomeFeature)
  5. Open a pull Request

License

Distributed under the GNU AGPLv3 License. See LICENSE.txt for more information.

Contact

Acknowledgments

List of resources that were helpful and would like to give credit to.