Skip to content

Updating documentation to explain Boost deprecation. #239

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.

Sign up for GitHub

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

Merged
arcuru merged 2 commits into from
Apr 6, 2019
Merged

Updating documentation to explain Boost deprecation. #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59dba67
Updating documentation to explain Boost deprecation.
arcuru Mar 24, 2019
ac87418
Adding some more notes to the track README.
arcuru Apr 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ There are not many active contributors, so anyone reviewing PRs or Issues, even

## Adding an exercise

Note: We are in the process of transitioning from using the Boost test suite to
Catch, see [#233](https://github.com/exercism/cpp/issues/233). As such, we will
not be taking any new exercises that use the Boost test suite. Please see one
of the exercises that use Catch for examples on how that is setup.

Additionally, any exercises submitted while that work is ongoing will not be a
priority, so may take a while to review.

Here is a list of things that need to be done to add an exercise to this track.

1. Add the exercise under the exercises/ directory.
Expand Down
9 changes: 6 additions & 3 deletions docs/INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,17 @@ improve the CMake support.

### Prerequisite: Boost 1.59+

**We are in the process of transitioning away from using Boost for most
exercises because it is difficult to install on some platforms. You can
follow the progress, or help, [on Github](https://github.com/exercism/cpp/issues/233).**

The unit tests use Boost.Test, the unit testing framework included with
[Boost](http://www.boost.org/index.html). You may find other libraries
in Boost useful to you as you work through the exercises.
You will need to download and install Boost. As of this writing Boost
1.59+ is the required version. You will need a compiled version of the
boost libraries Boost.Test, Boost.DateTime and Boost.Regex, or you will
need to download from source and build the library yourself.
boost libraries Boost.Test and Boost.DateTime, or you will need to
download from source and build the library yourself.

If you are having difficulties installing Boost for use with exercism,
[ask for help](https://github.com/exercism/cpp/issues).
Expand Down Expand Up @@ -166,4 +170,3 @@ If all else fails you can download the source and build it yourself,
but you should prefer a prebuilt distribution to make things easier.
Bootstrap instructions are on the
[Boost getting started page](http://www.boost.org/doc/libs/release/more/getting_started/index.html).