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

Liftoff fix #57

Merged
merged 8 commits into from
Nov 16, 2017
Merged

Liftoff fix #57

merged 8 commits into from
Nov 16, 2017

Conversation

GretaCB
Copy link
Contributor

@GretaCB GretaCB commented Nov 16, 2017

While double checking that this works, found a couple bugs. Related to mapbox/node-cpp-skel#87

Also adding more detailed docs for how to get started.

cc @mapbox/core-tech

README.md Outdated

### Setup tests
Since header-only libraries are _not_ compiled, they require a compiled parent. This is done by using the [`#include`](https://github.com/mapbox/cpp/blob/master/glossary.md#include) keyword. We can use a compiled test file to use your new header, using [Catch](https://github.com/catchorg/Catch2) for assertions.

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice work starting to spell this out. The parent metaphor is a good idea, but I'm getting snagged on it, since I think the header would make more sense to be the "parent" since the .cpp depends on it. How about: Since header-only libraries are _not_ normally compiled themselves, to test them you need to [#include](https://github.com/mapbox/cpp/blob/master/glossary.md#include) them in a .cpp(aka a [translation unit](https://github.com/mapbox/cpp/blob/master/glossary.md#translation-unit)) to compile and run their code. We recommend using [Catch](https://github.com/catchorg/Catch2) to make writing this.cpp` file easy.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Awesome, thanks @springmeyer ! Just pushed.

Copy link
Contributor

Choose a reason for hiding this comment

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

@GretaCB

@GretaCB GretaCB merged commit c609268 into master Nov 16, 2017
@GretaCB GretaCB deleted the liftoff-fix branch November 16, 2017 23:43
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.

2 participants