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

Update readme to new build system #200

Merged
merged 4 commits into from
Dec 9, 2023
Merged

Update readme to new build system #200

merged 4 commits into from
Dec 9, 2023

Conversation

lionkor
Copy link
Member

@lionkor lionkor commented Dec 5, 2023

Now building is like 2 steps, so the readme reflects that now.

Copy link
Collaborator

@Lucky4Luuk Lucky4Luuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, this change seems pretty good to me, but there's a few notes I have:

  • You have added build instructions, but the old build instructions still seem to be there. They are listed right underneath the runtime dependencies.
  • The new build instructions don't list the requirements for building on Windows. I think this is worth writing down?
  • In "Supported Operating Systems", it still links to the Prerequisites section, which is missing.

@Starystars67
Copy link
Member

The points @Lucky4Luuk makes here are very good, Especially the steps for windows as that would be me :)

@lionkor
Copy link
Member Author

lionkor commented Dec 6, 2023

Sorry @Lucky4Luuk if its not clear, but the windows build works the same. That was most of the point of this rewrite of the build system - ill fix the point about the old instructions.

@lionkor
Copy link
Member Author

lionkor commented Dec 6, 2023

So @Starystars67 the same steps on windows, you just open the cmakelists with visual studio and it should just work

Copy link
Collaborator

@Lucky4Luuk Lucky4Luuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now, I have no more comments!

@Lucky4Luuk Lucky4Luuk merged commit ef45efe into master Dec 9, 2023
5 checks passed
@Lucky4Luuk Lucky4Luuk deleted the update-readme branch December 9, 2023 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants