Skip to content

Commit

Permalink
Subject: Simplify Installation Instructions
Browse files Browse the repository at this point in the history
Body:
- Updated README and include/README.md for basic installation with guide link.
  • Loading branch information
aditya-borse committed Oct 23, 2023
1 parent 70e8c25 commit 7163882
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 37 deletions.
19 changes: 1 addition & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <graaflib/directed_graph>
```

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

Expand Down
20 changes: 1 addition & 19 deletions include/README.md
Original file line number Diff line number Diff line change
@@ -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 <graaflib/directed_graph.h>
```
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).

0 comments on commit 7163882

Please sign in to comment.