update c readme

dzcode-io · Apr 20, 2024 · 7d10656 · 7d10656
1 parent 53e7b5f
commit 7d10656
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ You can find more about each language by clicking on the language name
 | [Java](./java)             | n/a                                                                                                    | n/a                                                                                               | n/a                                                                                                                      | n/a                                                                                                     |
 | [C#](./csharp)             | n/a                                                                                                    | n/a                                                                                               | n/a                                                                                                                      | n/a                                                                                                     |
 | [Rust](./rust)             | WIP                                                                                                    | WIP                                                                                               | WIP                                                                                                                      | n/a                                                                                                     |
-| [C](./c)             | WIP                                                                                                    | WIP                                                                                               | WIP                                                                                                                      | n/a                                                                                                     |
+| [C](./c)             | `kuliya/1.0.0`                                                                                                    | ![](https://github.com/dzcode-io/kuliya/actions/workflows/c-checks.yml/badge.svg)                                                                                               | WIP                                                                                                                      | n/a                                                                                                     |
 
 ## Contributing
 

diff --git a/c/README.md b/c/README.md
@@ -2,6 +2,41 @@
 
 Algeria's college hierarchy dataset as a C library
 
+# Installation
+
+You can use `kuliya` library with one of these 2 options:
+
+1. Build it locally as it shown in [Get Started](#get-started) section then copy `kuliya.h` and `data.h` to your project.
+
+2. Use conan package manager in your CMake project by followin these steps:
+    - Add `kuliya` recipe to your `conanfile.txt`:
+    ```
+    [requires]
+    kuliya/1.0.0
+
+    [generators]
+    CMakeDeps
+    CMakeToolchain
+    ```
+    - Install the recipe with conan:
+    ```sh
+    conan install . --output-folder=build --build=missing
+    ```
+    - Update your `CMakeLists.txt` file accordingly:
+    ```cmake
+    cmake_minimum_required(VERSION 3.15)
+    project(sandbox C)
+
+    find_package(kuliya REQUIRED)
+
+    add_executable(${PROJECT_NAME} src/main.c)
+
+    target_link_libraries(${PROJECT_NAME} kuliya::kuliya)
+    ```
+    - Build and run your executable.
+
+You can check the usage [here](#usage).
+
 # Prerequisites
 
 - [CMake](https://cmake.org/download/) build system (minimum required version 3.19)