diff --git a/README.md b/README.md index f4b3115e..8569a2ba 100644 --- a/README.md +++ b/README.md @@ -49,24 +49,7 @@ Graaf is designed with the goal of simplifying graph-related tasks. It offers a # Installation -The most straightforward way to use the Graaf in your project is to include it as a header-only library. Please take a -look at the [installation guide](https://bobluppes.github.io/graaf/docs/quickstart/installation) for alternative -installation methods. - -## Header-Only Library - -The Graaf libary can be included as a header-only library. All it requires is a compiler with **C++ 20 support**. - -Download the `header-only` library from our [release page](https://github.com/bobluppes/graaf/releases) and add -the `include/graaflib` directory to your include path. You can now use Graaf in your source files: - -```c++ -// main.cpp -#include -``` - -For more details or alternative installation methods, see -the [installation guide](https://bobluppes.github.io/graaf/docs/quickstart/installation). +Installing Graaf on your project is easy! Simply copy the `graaflib` directory to your project and add it to your include path. For more details or alternative installation methods, take a look at our [installation guide](https://bobluppes.github.io/graaf/docs/quickstart/installation). # How to use Graaf diff --git a/include/README.md b/include/README.md index 2ee96cd3..01f22749 100644 --- a/include/README.md +++ b/include/README.md @@ -1,20 +1,2 @@ # Graaf Header-Only Installation -Installing Graaf on your project is easy! Simply copy the `graaflib` directory to your project and add it to your include path. For more details or alternative installation methods, take a look at our [installation guide](https://bobluppes.github.io/graaf/docs/quickstart/installation). - -1. Copy `graaflip` to your project. -2. Before compiling, add the directory to your include path. - ```bash - # For C compiler - export C_INCLUDE_PATH="/full/path/to/include/graaflib/:$C_INCLUDE_PATH" - # For Cpp compiler - export CPLUS_INCLUDE_PATH="/full/path/to/include/graaflib/:$CPLUS_INCLUDE_PATH" - ``` - - Or in CMake: - ```CMake - include_directories("graaf/src/graaflib") - ``` -3. Include the graaf header in your sources. - ```c++ - #include - ``` \ No newline at end of file +Installing Graaf on your project is easy! Simply copy the `graaflib` directory to your project and add it to your include path. For more details or alternative installation methods, take a look at our [installation guide](https://bobluppes.github.io/graaf/docs/quickstart/installation). \ No newline at end of file