-
Notifications
You must be signed in to change notification settings - Fork 41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
added environment set up link #138
added environment set up link #138
Conversation
Codecov ReportAll modified lines are covered by tests ✅ see 17 files with indirect coverage changes 📢 Thoughts on this report? Let us know!. |
README.md
Outdated
# 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently we can distinct two types of users:
- Users wanting to integrate
graaf
into their own project - Developers directly working on the graaf library to improve it (like you 😄 )
This readme and the quickstart guide are focused towards the first users, while the wiki is meant for the second.
Therefore I am a little hesitant linking to the wiki here. But maybe we could rephrase it to make this distinction more clear. And we can point to the wiki for troubleshooting.
What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah sure, that's a good point, I wasn't sure about this so I'm gonna update this for you
Thanks, this is a good point! I will try it out and create a ticket for it.
Good idea, I think printing the dot representation might be helpful to understand how some of the algorithms work. Is this something you would like to work on? I can also create a ticket for it |
I would love to take on this issue, but currently I can't get it to work on my computer right now, so I guess I would just deal with the readme first |
@bobluppes I put removed that part and put it in contributing, although we have a link for it already in the wiki page. Let me know if it is necessary, or else you can just close the PR if it's insignificant. |
Sorry to hear that, I will definitely work on improving this |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, I like the addition 👍🏻
@bobluppes I believe we need to make 2 more things: