Skip to content

Commit 68349fa

Browse files
authored
chore: updates for README (#121)
1 parent eb0b5a5 commit 68349fa

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,17 @@ Note that sometimes iOS applications won't crash while the USB cable is connecte
8989

9090
#### Android
9191

92-
> ![Note]
92+
> [!Note]
9393
> Code is aggressively optimized when building for Android. Oftentimes, Unreal's build process optimizes away code that generates simple errors used in testing. To test a null pointer dereference, you can add the `volatile` keyword to work around compiler optimizations.
9494
9595

9696
Fatal Errors on Android raise a `SIGTRAP` and require extra configuration so that they can be reported to BugSplat.
97+
98+
<details>
99+
<summary>Click to reveal Android Error Output Device code </summary>
97100

98101
[MyUnrealCrasherErrorOutputDevice.h](https://github.com/BugSplat-Git/my-unreal-crasher/blob/b0a805505a661d6729657bcae724e64dea31484b/Source/MyUnrealCrasher/MyUnrealCrasherAndroidErrorOutputDevice.h)
102+
99103
```cpp
100104
#pragma once
101105

@@ -120,8 +124,8 @@ private:
120124
```
121125

122126
[MyUnrealCrasherErrorOutputDevice.cpp](https://github.com/BugSplat-Git/my-unreal-crasher/blob/b0a805505a661d6729657bcae724e64dea31484b/Source/MyUnrealCrasher/MyUnrealCrasherAndroidErrorOutputDevice.cpp)
127+
123128
```cpp
124-
// Copyright © BugSplat. All rights reserved.
125129
#include "MyUnrealCrasherAndroidErrorOutputDevice.h"
126130

127131
#include "CoreMinimal.h"
@@ -233,7 +237,9 @@ void FMyUnrealCrasherAndroidErrorOutputDevice::RequestExit( bool Force, const TC
233237
}
234238
#endif
235239
```
240+
236241
[MyUnrealCrasherGameInstance.h](https://github.com/BugSplat-Git/my-unreal-crasher/blob/b0a805505a661d6729657bcae724e64dea31484b/Source/MyUnrealCrasher/MyUnrealCrasherGameInstance.h)
242+
237243
```cpp
238244
#pragma once
239245
@@ -252,6 +258,7 @@ public:
252258
```
253259

254260
[MyUnrealCrasherGameInstance.cpp](https://github.com/BugSplat-Git/my-unreal-crasher/blob/b0a805505a661d6729657bcae724e64dea31484b/Source/MyUnrealCrasher/MyUnrealCrasherGameInstance.cpp)
261+
255262
```cpp
256263
// Copyright © BugSplat. All rights reserved.
257264
#include "MyUnrealCrasherGameInstance.h"
@@ -272,6 +279,8 @@ void UMyUnrealCrasherGameInstance::Init()
272279
}
273280
```
274281

282+
</details>
283+
275284
### Xbox and PlayStation
276285

277286
BugSplat can provide instructions for implementing Unreal crash reporting on Xbox and PlayStation. Please email us at [[email protected]](mailto:[email protected]) for more info.
@@ -299,3 +308,4 @@ If everything is configured correctly, you should see something that resembles t
299308
## 🧑‍💻 Contributing
300309
301310
BugSplat ❤️s open source! If you feel that this package can be improved, please open an [Issue](https://github.com/BugSplat-Git/bugsplat-unreal/issues). If you have an awesome new feature you'd like to implement, we'd love to merge your [Pull Request](https://github.com/BugSplat-Git/bugsplat-unreal/pulls). You can also send us an [email](mailto:[email protected]), join us on [Discord](https://discord.gg/K4KjjRV5ve), or message us via the in-app chat on [bugsplat.com](https://bugsplat.com).
311+

0 commit comments

Comments
 (0)