From b24d7dd28eaef013a5b5e48f2cca9b8aaea9d3a8 Mon Sep 17 00:00:00 2001 From: Lqvrent Date: Tue, 1 Nov 2022 00:53:50 +0100 Subject: [PATCH] docs(readme): updated readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 32572d7..75dad5b 100644 --- a/README.md +++ b/README.md @@ -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.
You can also use the library in your project by adding the following lines to your `CMakeLists.txt`: ```cmake @@ -14,7 +14,7 @@ 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/).
You can also build it locally (with Doxygen) by running the following commands : ```bash @@ -22,7 +22,7 @@ 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. @@ -43,7 +43,7 @@ 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:
**1.** Fork the repository.
**2.** Create a new branch.
@@ -51,5 +51,5 @@ If you want to modify the library, you can do so by following these steps:
**4.** Create a pull request.

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.