Skip to content

Commit 9ab1d68

Browse files
authored
Update README.md
1 parent e434a52 commit 9ab1d68

1 file changed

Lines changed: 94 additions & 1 deletion

File tree

README.md

Lines changed: 94 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
# Labrador
2-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
2+
3+
<img style="float: right;" align="left" src="https://images.unsplash.com/photo-1588022274642-f238f77ec193?q=80&w=2671&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D" width="200">
34

45
C++ Queue Elaboration Framework
56

7+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![GitHub release](https://img.shields.io/github/release/ZigRazor/Labrador.svg)](https://GitHub.com/ZigRazor/Labrador/releases/) [![CMake](https://github.com/ZigRazor/Labrador/actions/workflows/cmake.yml/badge.svg)](https://github.com/ZigRazor/Labrador/actions/workflows/cmake.yml)
8+
9+
[![codecov](https://codecov.io/gh/ZigRazor/Labrador/graph/badge.svg?token=24SM5HBW6C)](https://codecov.io/gh/ZigRazor/Labrador) [![CodeFactor](https://www.codefactor.io/repository/github/zigrazor/labrador/badge)](https://www.codefactor.io/repository/github/zigrazor/labrador)
10+
11+
[![Generic badge](https://img.shields.io/badge/required-C++20-Green.svg)](https://shields.io/) [![Generic badge](https://img.shields.io/badge/Required-CMake3.16-Green.svg)](https://shields.io/)
12+
613
## Table of Contents
714
- [Description](#description)
815
- [Features](#features)
@@ -13,3 +20,89 @@ C++ Queue Elaboration Framework
1320
- [Contact](#contact)
1421
- [Acknowledgements](#acknowledgements)
1522

23+
## Description
24+
25+
Labrador is a C++ Queue library. This project aims to fulfill a framework for concurrent queue elaboration. By using Labrador, users can:
26+
- Create queues of different type ( ex. Bounded, Lock-wait, Concurrent )
27+
- Craete more sophisticated application that use queue processor to process in a simple way the enqueued items.
28+
29+
## Features
30+
31+
- Concurrent Queue
32+
- Boundend Queue
33+
- Lock-Wait Bounded Queue
34+
- Queue Processor
35+
- Asynchronous Queue Processor
36+
37+
## Installation
38+
39+
To install and set up Labrador, follow these steps:
40+
41+
1. **Clone the repository:**
42+
```bash
43+
git clone https://github.com/ZigRazor/Labrador.git
44+
```
45+
2. **Navigate to the project directory:**
46+
```bash
47+
cd Labrador
48+
```
49+
3. **Prepare CMake:**
50+
```bash
51+
mkdir build
52+
cd build
53+
cmake ..
54+
```
55+
4. **Install Library**
56+
```bash
57+
make install
58+
```
59+
60+
## Usage
61+
62+
You can use the Library in your project with CMake adding the following lines:
63+
64+
```cmake
65+
CPMAddPackage(
66+
NAME Labrador
67+
GITHUB_REPOSITORY ZigRazor/Labrador
68+
GIT_TAG origin/main
69+
)
70+
```
71+
or install it and the add to the include path *{StandardIncludePath}/DogBreeds/Labrador*.
72+
73+
For simple use you can see the [Example](https://github.com/ZigRazor/Labrador/tree/main/example)
74+
For more detailed usage instructions, refer to the documentation.
75+
76+
## Contributing
77+
We welcome contributions to Labrador! To contribute, follow these steps:
78+
79+
1. **Fork the repository.**
80+
2. **Create a new branch:**
81+
```bash
82+
git checkout -b feature/your-feature-name
83+
```
84+
3. **Make your changes and commit them:**
85+
```bash
86+
git commit -m "Add your commit message"
87+
```
88+
4. **Push to the branch:**
89+
```bash
90+
git push origin feature/your-feature-name
91+
```
92+
5. **Create a pull request.**
93+
94+
Please read our [contributing guidelines](https://github.com/ZigRazor/Labrador/blob/main/CONTRIBUTING.md) for more details.
95+
96+
## License
97+
This project is licensed under the MIT License. See the [LICENSE](https://github.com/ZigRazor/Labrador/blob/main/LICENSE) file for details.
98+
99+
## Contact
100+
If you have any questions, suggestions, or feedback, feel free to reach out:
101+
102+
- Email: zigrazor@gmail.com
103+
- GitHub Issues: [issues](https://github.com/ZigRazor/Labrador/issues)
104+
105+
## Acknowledgements
106+
We would like to thank the following individuals for their support:
107+
108+
[![Contributors](https://contrib.rocks/image?repo=zigrazor/Labrador)](https://github.com/ZigRazor/Labrador/graphs/contributors)

0 commit comments

Comments
 (0)