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.

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

Jump to bottom

Update README #517

Merged
merged 10 commits into from
Jun 25, 2024
Merged

Update README #517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2fbb564
Remove Android from README
GLinnik21 Jun 24, 2024
a008bdd
Update installation Guide
GLinnik21 Jun 24, 2024
f5a1742
Reorder sections and grouping
GLinnik21 Jun 24, 2024
9dfe6c3
Remove server reporting section
GLinnik21 Jun 24, 2024
561d5e4
Update README.md with SPM Index badges
GLinnik21 Jun 24, 2024
49d20a9
Remove Examples section
GLinnik21 Jun 25, 2024
871e87a
Restructure the README
GLinnik21 Jun 25, 2024
a43658f
Add OOM to advanced
GLinnik21 Jun 25, 2024
4749e2a
Describe the modules
GLinnik21 Jun 25, 2024
a3eb6a7
Update CODE_TOUR
GLinnik21 Jun 25, 2024
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
4 changes: 2 additions & 2 deletions CODE_TOUR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ These are the main parts of `KSCrashC.c`:

#### Installation

`kscrash_install()` installs and prepares the KSCrash system to handle crashes. You can configure KSCrash using the various configuration functions in this file (`kscrash_setMonitoring() and such`) before or after install.
`kscrash_install()` installs and prepares the KSCrash system to handle crashes. You configure KSCrash by creating and populating a `KSCrashCConfiguration` struct with your desired settings. This configuration struct is then passed to the installation function, allowing you to set up all crash handling parameters in one step.

#### Configuration

All of the main configuration settings are set via `kscrash_setXYZ()`.
All of the main configuration settings are set via `KSCrashCConfiguration`.

#### App State

Expand Down
Loading