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

Install boost on windows #919

Merged
merged 4 commits into from
Oct 16, 2024
Merged

Conversation

heijp06
Copy link
Contributor

@heijp06 heijp06 commented Oct 12, 2024

@vaeng I took a first stab at writing the installation instructions for Boost on Windows. Could you take a look?

Copy link
Contributor

Hello. Thanks for opening a PR on Exercism 🙂

We ask that all changes to Exercism are discussed on our Community Forum before being opened on GitHub. To enforce this, we automatically close all PRs that are submitted. That doesn't mean your PR is rejected but that we want the initial discussion about it to happen on our forum where a wide range of key contributors across the Exercism ecosystem can weigh in.

You can use this link to copy this into a new topic on the forum. If we decide the PR is appropriate, we'll reopen it and continue with it, so please don't delete your local branch.

If you're interested in learning more about this auto-responder, please read this blog post.


Note: If this PR has been pre-approved, please link back to this PR on the forum thread and a maintainer or staff member will reopen it.

@github-actions github-actions bot closed this Oct 12, 2024
@vaeng vaeng reopened this Oct 12, 2024
Copy link
Contributor

@ahans ahans left a comment

Choose a reason for hiding this comment

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

Thanks a lot for your effort improving documentation. Let's see if we can make it even easier for students!

docs/INSTALLATION.md Outdated Show resolved Hide resolved
docs/INSTALLATION.md Outdated Show resolved Hide resolved
docs/INSTALLATION.md Outdated Show resolved Hide resolved
Copy link
Contributor

@vaeng vaeng left a comment

Choose a reason for hiding this comment

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

Thank you for the guide.

Apart from the comments from Shane, please also see the exercism formatting guidelines for markdown documents.

Especially the part about links and keeping each sentence to its own line. It helps a lot with maintaining and tracking in git.

@heijp06
Copy link
Contributor Author

heijp06 commented Oct 13, 2024

Thank you both, that is really great feedback!

I will try to see if I can make it work the way @ahans suggests. I prefer using something under %USERPROFILE% to install Boost, maybe just %USERPROFILE%\Libs.

Alternatively there is still the option to use a package manager like vcpkg which would allow one to just put boost-date-time in the project folder. I have not tried that route yet, but could if you think it is worth the try.

@vaeng The existing INSTALLATION.md does not follow the rules you link to, especially with regards to reference links. If I am going to adhere to the guidelines, I think it is best the entire document does. Would you want me to go over the entire document and make it rules compliant? If so would you want me to do that in this PR or in a separate PR? The latter option makes the most sense to me since we then separate the formatting changes to the existing document from the information I intend to add.

@vaeng
Copy link
Contributor

vaeng commented Oct 13, 2024

I think a separate PR to format the rest of the document is the cleanest solution, if your additions are already compliant.

@heijp06
Copy link
Contributor Author

heijp06 commented Oct 13, 2024

@vaeng, @ahans I did as you suggested. Things should be (much) better now.

@vaeng vaeng added x:type/docs Work on Documentation hacktoberfest-accepted labels Oct 16, 2024
@vaeng vaeng merged commit 3dfdc3a into exercism:main Oct 16, 2024
7 checks passed
@heijp06 heijp06 deleted the docs_install_boost_on_windows branch October 17, 2024 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:type/docs Work on Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants