From 8e461e6f52de252de03e861825b15e47fc221bdc Mon Sep 17 00:00:00 2001 From: Anwyll Le Date: Tue, 3 Oct 2023 22:05:56 -0400 Subject: [PATCH 1/2] add environment set up link --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 24c7b7ca..846e99ef 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,8 @@ Graaf is designed with the goal of simplifying graph-related tasks. It offers a # Installation +Before you can use the Graaf library, make sure you have your [development environment set up](https://github.com/bobluppes/graaf/wiki/development-setup). Currently, our guide assuming your operating system is Linux. If you're using Windows and IDE such as Visual Studio, Visual Studio Code, feel free to create a guide and submit a pull request showing step-by-step on how you did it on our installation webpage. + 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. From 0084dc84a6939f609d073b956db9395bb1df6f4c Mon Sep 17 00:00:00 2001 From: Anwyll Le Date: Sat, 7 Oct 2023 12:48:35 -0400 Subject: [PATCH 2/2] moved development setup to contributing --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 846e99ef..bf98c12a 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ analysis, and data mining. Graaf: A Lightweight, Header-Only C++20 Graph Library **Key Features**: + - **Header-only**: No separate compilation or linking required. - **Generality**: Supports user-defined vertex and edge classes. - **Algorithm Support**: Provides a range of graph algorithms. @@ -46,11 +47,8 @@ Graaf: A Lightweight, Header-Only C++20 Graph Library **Purpose**: Graaf is designed with the goal of simplifying graph-related tasks. It offers a lightweight alternative to the [Boost Graph Library (BGL)](https://www.boost.org/doc/libs/1_82_0/libs/graph/doc/index.html) and is built for simplicity and extensibility. With Graaf, you can easily create, manipulate, and analyze graphs, making it suitable for a wide range of applications. - # Installation -Before you can use the Graaf library, make sure you have your [development environment set up](https://github.com/bobluppes/graaf/wiki/development-setup). Currently, our guide assuming your operating system is Linux. If you're using Windows and IDE such as Visual Studio, Visual Studio Code, feel free to create a guide and submit a pull request showing step-by-step on how you did it on our installation webpage. - 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. @@ -136,7 +134,7 @@ take a look at the [docs](https://bobluppes.github.io/graaf/docs/algorithms/intr The Graaf library welcomes contributions 🎊 If you're interested in improving, fixing bugs, or adding features, please refer to -the [wiki](https://github.com/bobluppes/graaf/wiki) for guidelines. Check out our roadmap +the [wiki](https://github.com/bobluppes/graaf/wiki) for guidelines and have your [development environment set up](https://github.com/bobluppes/graaf/wiki/development-setup) before you start. Check out our roadmap on [YouTrack](https://graaf.youtrack.cloud/agiles/147-2/current) to stay up to date on planned features and improvements. We also have an [issue tracker](https://github.com/bobluppes/graaf/issues) for bug reports and feature requests.