Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zigrazor/chihuahua
C++ unique identifier utilities
https://github.com/zigrazor/chihuahua
cplusplus cpp cpp-library cpp20 id-generation id-generator unique-id unique-id-generator unique-identifier utility utility-library
Last synced: 9 days ago
JSON representation
C++ unique identifier utilities
- Host: GitHub
- URL: https://github.com/zigrazor/chihuahua
- Owner: ZigRazor
- License: mit
- Created: 2024-05-23T15:21:10.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T08:33:13.000Z (5 months ago)
- Last Synced: 2024-06-17T09:58:33.096Z (5 months ago)
- Topics: cplusplus, cpp, cpp-library, cpp20, id-generation, id-generator, unique-id, unique-id-generator, unique-identifier, utility, utility-library
- Language: CMake
- Homepage:
- Size: 35.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Chihuahua
C++ unique identifier utilities
[](LICENSE) [](https://GitHub.com/ZigRazor/Chihuahua/releases/) [](https://github.com/ZigRazor/Chihuahua/actions/workflows/cmake.yml)
[](https://codecov.io/gh/ZigRazor/Chihuahua) [](https://www.codefactor.io/repository/github/zigrazor/chihuahua)
[](https://shields.io/) [](https://shields.io/)
## Table of Contents
- [Description](#description)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)
## 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:**
```bash
git clone https://github.com/ZigRazor/Chihuahua.git
```
2. **Navigate to the project directory:**
```bash
cd Chihuahua
```
3. **Prepare CMake:**
```bash
mkdir build
cd build
cmake ..
```
4. **Install Library**
```bash
make install
```
## Usage
You can use the Library in your project with CMake adding the following lines:
```cmake
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](https://github.com/ZigRazor/Chihuahua/tree/main/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:**
```bash
git checkout -b feature/your-feature-name
```
3. **Make your changes and commit them:**
```bash
git commit -m "Add your commit message"
```
4. **Push to the branch:**
```bash
git push origin feature/your-feature-name
```
5. **Create a pull request.**
Please read our [contributing guidelines](https://github.com/ZigRazor/Chihuahua/blob/main/CONTRIBUTING.md) for more details.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/ZigRazor/Chihuahua/blob/main/LICENSE) file for details.
## Contact
If you have any questions, suggestions, or feedback, feel free to reach out:
- Email: [email protected]
- GitHub Issues: [issues](https://github.com/ZigRazor/Chihuahua/issues)
## Acknowledgements
We would like to thank the following individuals for their support:
[](https://github.com/ZigRazor/Chihuahua/graphs/contributors)
## Credits
Photo of Jairo Alzate on Unsplash