Skip to content

Commit 2c77eb4

Browse files
committedMay 1, 2024
readme: add basic readme and license
1 parent 34f324c commit 2c77eb4

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed
 

‎LICENSE

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright (c) 2024 masscry
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Corey (WORK IN PROGRESS)
2+
3+
## Description
4+
5+
Corey is a simple async framework that allows you to build asynchronous applications in C++. It provides a lightweight API for handling asynchronous tasks and managing concurrency. We are using io_uring to process IO requests and stackless C++20 coroutines for user code.
6+
7+
## Minimal Requirements
8+
9+
To use Corey, you need the following:
10+
11+
- C++20 compatible compiler
12+
- Linux operating system
13+
- io_uring library
14+
15+
Make sure you have these dependencies installed before proceeding with the installation and usage of Corey.
16+
17+
## Roadmap
18+
19+
- [ ] Basic coroutine support `>_____<`
20+
21+
## Contributing
22+
23+
We welcome contributions to Corey! To contribute, please follow these steps:
24+
25+
1. Fork the repository.
26+
2. Create a new branch for your feature or bug fix.
27+
3. Make your changes and commit them to your branch.
28+
4. Push your branch to your forked repository on GitHub.
29+
5. Open a pull request from your branch to the main repository.
30+
6. Provide a clear and descriptive title for your pull request.
31+
7. Include a detailed description of the changes you made.
32+
8. Wait for the maintainers to review your pull request.
33+
9. Address any feedback or comments from the maintainers.
34+
10. Once your pull request is approved, it will be merged into the main repository.
35+
36+
Thank you for contributing to Corey!
37+
38+
## License
39+
40+
Distributed under the MIT License. See `LICENSE` for more information.
41+
42+
## Contact
43+
For any questions or inquiries, please feel free to contact us at:
44+
- Email: masscry@gmail.com
45+
- GitHub: [Corey GitHub Repository](https://github.com/masscry/corey)

0 commit comments

Comments
 (0)
Please sign in to comment.