Skip to content

Commit 679913e

Browse files
docs: update readme (#1091)
* updated readme * added link to C+20 requirement issue * Add build prerequisites into readme * Added additional link to Contributing.md * apply suggestion from code review Co-authored-by: Mischan Toosarani-Hausberger <mischan@abovevacant.com> * apply suggestions from code review --------- Co-authored-by: Mischan Toosarani-Hausberger <mischan@abovevacant.com>
1 parent 99b1539 commit 679913e

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -42,21 +42,20 @@ Using the `sentry-native` SDK in a standalone use case is currently an experimen
4242
## Downloads
4343

4444
The SDK can be downloaded from the [Releases] page, which also lists the
45-
changelog of every version.
45+
changelog of every version. We recommend using our release packages, but if you want to use this repo directly, please follow the [contribution guide](./CONTRIBUTING.md) to understand the setup better.
4646

4747
[releases]: https://github.com/getsentry/sentry-native/releases
4848

4949
### What is Inside
5050

5151
The SDK bundle contains the following folders:
5252

53-
- `external`: These are external projects which are consumed via
54-
`git submodules`.
5553
- `include`: Contains the Sentry header file. Set the include path to this
5654
directory or copy the header file to your source tree so that it is available
5755
during the build.
5856
- `src`: Sources of the Sentry SDK required for building.
5957
- `ndk`: Sources for the Android NDK JNI layer.
58+
- `external`: These are vendored dependencies fetched via git submodules (use `git submodules update --init --recursive` if you use a git clone rather than a release).
6059

6160
## Platform and Feature Support
6261

@@ -93,7 +92,9 @@ per platform, and can also be configured for cross-compilation.
9392
System-wide installation of the resulting sentry library is also possible via
9493
CMake.
9594

96-
Building the Crashpad Backend requires a `C++14` compatible compiler.
95+
The prerequisites for building differ depending on the platform and backend. You will always need `CMake` to build the code. Additionally, when using the `crashpad` backend, `zlib` is required. On Linux and macOS, `libcurl` is a prerequisite. For more details, check out the [contribution guide](./CONTRIBUTING.md).
96+
97+
Building the Crashpad Backend [requires a `C++20` compatible compiler](https://github.com/getsentry/sentry-native/issues/1041). In particular, the standard library must support `std::ranges` for `mini_chromium` (a core library of `crashpad`).
9798

9899
**Build example**:
99100

0 commit comments

Comments
 (0)