Skip to content

Commit

Permalink
docs(readme): updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Lqvrent committed Oct 31, 2022
1 parent 7ff86b5 commit b24d7dd
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Build](https://github.com/Lqvrent/lololib/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/Lqvrent/lololib/actions/workflows/build.yml) [![Unit tests](https://github.com/Lqvrent/lololib/actions/workflows/unit_tests.yml/badge.svg?branch=main)](https://github.com/Lqvrent/lololib/actions/workflows/unit_tests.yml) [![Unit tests](https://img.shields.io/badge/Code%20Coverage-100%25-success?style=flat)](https://github.com/Lqvrent/lololib/actions/workflows/unit_tests.yml)
# lololib - Cross-platform utilities library for C πŸ› 
## Usage βš™οΈ
# lololib - Cross-platform multi-purposes library for C
## βš™οΈ Usage
In the `template/` folder, you can see how to use the library to build a binary.<br />
You can also use the library in your project by adding the following lines to your `CMakeLists.txt`:
```cmake
Expand All @@ -14,15 +14,15 @@ FetchContent_MakeAvailable(lololib)
target_link_libraries(${PROJECT_NAME} lolo)
target_include_directories(${PROJECT_NAME} PRIVATE ${lololib_SOURCE_DIR}/includes)
```
## Documentation πŸ“š
## πŸ“š Documentation
You can find the documentation [here](https://lqvrent.github.io/lololib/). <br />
You can also build it locally (with Doxygen) by running the following commands :
```bash
mkdir build && cd build
cmake -DBUILD_WITH_DOCS=ON ..
make docs # or mingw32-make docs, depending if you're on Windows
```
## Roadmap 🎯
## 🎯 Roadmap
- [x] Add unit tests
- [x] Add the documentation on Github pages programmatically.
- [x] Make the library cross-platform.
Expand All @@ -43,13 +43,13 @@ make docs # or mingw32-make docs, depending if you're on Windows
- [ ] Networking - Server (cross-platform !)
- [ ] `v2.0.0` Release πŸš€
- [ ] And more ! (If you have any ideas, feel free to open an issue, I don't bite and more importantly, I don't know what to do next !)
## Contributing 🀝
## 🀝 Contributing
If you want to modify the library, you can do so by following these steps:<br />
**1.** Fork the repository.<br />
**2.** Create a new branch.<br />
**3.** Make your changes.<br />
**4.** Create a pull request.<br /><br />
If you want to add a new feature, please open an issue first to discuss it.

## License πŸ“œ
## πŸ“œ License
This project is licensed under the `MIT` License. See the [LICENSE](/LICENSE) file for details.

0 comments on commit b24d7dd

Please sign in to comment.