/Chihuahua

C++ unique identifier utilities

Primary LanguageCMakeMIT LicenseMIT

Chihuahua

C++ unique identifier utilities

License GitHub release CMake

codecov CodeFactor

Generic badge Generic badge

Table of Contents

Description

Chihuahua is a C++ Unique Identifier Utilities Library. This project aims to fulfill a framework for manage Unique Identifier. By using Chihuahua, users can:

  • Create Unique Identifier

Features

  • UniqueId Class
  • UniqueIdGenerator Singleton

Installation

To install and set up Chihuahua, follow these steps:

  1. Clone the repository: 
    git clone https://github.com/ZigRazor/Chihuahua.git
  2. Navigate to the project directory:
cd Chihuahua
  1. Prepare CMake:
mkdir build
cd build
cmake ..
  1. Install Library 
    make install

Usage

You can use the Library in your project with CMake adding the following lines:

CPMAddPackage(
    NAME Chihuahua
    GITHUB_REPOSITORY ZigRazor/Chihuahua
    GIT_TAG origin/main
)

or install it and the add to the include path {StandardIncludePath}/DogBreeds/Chihuahua and to the linking_path {StandardLinkingPath}/DogBreeds/Chihuahua.

For simple use you can see the Example For more detailed usage instructions, refer to the documentation.

Contributing

We welcome contributions to Chihuahua! To contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch:
git checkout -b feature/your-feature-name
  1. Make your changes and commit them:
git commit -m "Add your commit message"
  1. Push to the branch:
git push origin feature/your-feature-name
  1. Create a pull request.

Please read our contributing guidelines for more details.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

If you have any questions, suggestions, or feedback, feel free to reach out:

Acknowledgements

We would like to thank the following individuals for their support:

Contributors

Credits

Photo of Jairo Alzate on Unsplash