Skip to content

Commit

Permalink
Update README (#517)
Browse files Browse the repository at this point in the history
* Remove Android from README

* Update installation Guide

* Reorder sections and grouping

* Remove server reporting section

* Update README.md with SPM Index badges

* Remove Examples section

* Restructure the README

* Add OOM to advanced

* Describe the modules

* Update CODE_TOUR
  • Loading branch information
GLinnik21 authored Jun 25, 2024
1 parent e17c597 commit 3bae1d8
Show file tree
Hide file tree
Showing 2 changed files with 215 additions and 134 deletions.
4 changes: 2 additions & 2 deletions CODE_TOUR.md
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

0 comments on commit 3bae1d8

Please sign in to comment.