chore: Add basic build docs. #114
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kinyoklion
commented
May 24, 2023
| @@ -23,7 +23,41 @@ This version of the LaunchDarkly SDK is compatible with POSIX environments (Linu | |||
| Getting started | |||
| --------------- | |||
|
|
|||
| Download a release archive from the [TODO](TODO) for use in your project. Refer to the [SDK documentation](TODO) for complete instructions on installing and using the SDK. | |||
| Download a release archive from the [Github releases]https://github.com/launchdarkly/cpp-sdks/releases?q=cpp-client&expanded=true) for use in your project. | |||
There was a problem hiding this comment.
This URL should be good enough for now, and we can improve it after we have made some releases.
cwaldren-ld
reviewed
May 24, 2023
README.md
Outdated
|
|
||
| 1. C++17 and above | ||
| 1. CMake 3.19 or higher | ||
| 1. Ninja |
There was a problem hiding this comment.
Is ninja actually required (vs make?)
There was a problem hiding this comment.
I will add an asterisk. It is required to use our build scripts.
cwaldren-ld
reviewed
May 24, 2023
README.md
Outdated
|
|
||
| 1. C++17 and above | ||
| 1. CMake 3.19 or higher | ||
| 1. Ninja |
There was a problem hiding this comment.
All steps are labeled (1)
There was a problem hiding this comment.
That is how markdown works.
There was a problem hiding this comment.
You can just put 1. and it automatically numbers them. Manually numbering just makes churn.
There was a problem hiding this comment.
This is an amazing moment for me today. I never knew this.
cwaldren-ld
approved these changes
May 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.