Skip to content
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

Merged

Conversation

LinhNguyenLe2109
Copy link
Contributor

@bobluppes I believe we need to make 2 more things:

  • Guide for other OS users like Window and MacOS. If possible you should try and see how you would do it in Window OS. It was really tough for me.
  • Easier, straightforward examples in installation guide. I checked the examples, maybe we need something that when we run it prints out something. Or maybe that's unnecessary because people don't use this library to print stuff but to calculate difficult algorithms

@codecov
Copy link

codecov bot commented Oct 4, 2023

Codecov Report

All modified lines are covered by tests ✅

see 17 files with indirect coverage changes

📢 Thoughts on this report? Let us know!.

README.md Outdated
Comment on lines 50 to 56
# 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.
Copy link
Owner

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?

Copy link
Contributor Author

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

@bobluppes
Copy link
Owner

Guide for other OS users like Window and MacOS. If possible you should try and see how you would do it in Window OS. It was really tough for me.

Thanks, this is a good point! I will try it out and create a ticket for it.

Easier, straightforward examples in installation guide. I checked the examples, maybe we need something that when we run it prints out something. Or maybe that's unnecessary because people don't use this library to print stuff but to calculate difficult algorithms

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

@LinhNguyenLe2109
Copy link
Contributor Author

Guide for other OS users like Window and MacOS. If possible you should try and see how you would do it in Window OS. It was really tough for me.

Thanks, this is a good point! I will try it out and create a ticket for it.

Easier, straightforward examples in installation guide. I checked the examples, maybe we need something that when we run it prints out something. Or maybe that's unnecessary because people don't use this library to print stuff but to calculate difficult algorithms

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

@LinhNguyenLe2109
Copy link
Contributor Author

@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.

@bobluppes
Copy link
Owner

Guide for other OS users like Window and MacOS. If possible you should try and see how you would do it in Window OS. It was really tough for me.

Thanks, this is a good point! I will try it out and create a ticket for it.

Easier, straightforward examples in installation guide. I checked the examples, maybe we need something that when we run it prints out something. Or maybe that's unnecessary because people don't use this library to print stuff but to calculate difficult algorithms

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

Sorry to hear that, I will definitely work on improving this

Copy link
Owner

@bobluppes bobluppes left a 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 bobluppes added the documentation Improvements or additions to documentation label Oct 7, 2023
@bobluppes bobluppes merged commit ffaa4d1 into bobluppes:main Oct 7, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants