| 1 | Read Me |
|---|
| 2 | ..:: -- -- -- -- -- -- -- -- -- -- ::.. |
|---|
| 3 | |
|---|
| 4 | CMCrashReporter is a group of classes, |
|---|
| 5 | special designed for Mac applications. |
|---|
| 6 | |
|---|
| 7 | CMCrashReporter collects crash-reports |
|---|
| 8 | and send those to a server of the |
|---|
| 9 | developer, in stead of Apple. |
|---|
| 10 | |
|---|
| 11 | CMCrashReporter is free and opensource. |
|---|
| 12 | You can edit CMCrashReporter if wanted. |
|---|
| 13 | If you find some bugs or have some feature requests, |
|---|
| 14 | please email us at info@codingmammoth.com so we can |
|---|
| 15 | update CMCrashReporter. |
|---|
| 16 | |
|---|
| 17 | Credits |
|---|
| 18 | ..:: -- -- -- -- -- -- -- -- -- -- ::.. |
|---|
| 19 | |
|---|
| 20 | CMCrashReporter is developed by |
|---|
| 21 | Jelle De Laender - CodingMammoth.com |
|---|
| 22 | |
|---|
| 23 | Thanks to Pieter Omvlee (bohemiancoding.com) |
|---|
| 24 | for the GUI-support. |
|---|
| 25 | |
|---|
| 26 | Compability |
|---|
| 27 | ..:: -- -- -- -- -- -- -- -- -- -- ::.. |
|---|
| 28 | |
|---|
| 29 | CMCrashReporter is compatible with |
|---|
| 30 | Tiger, Leopard and Snow Leopard. |
|---|
| 31 | |
|---|
| 32 | Depending on your project, it's compatible for |
|---|
| 33 | intel and PPC and GC (Garbage Collection). |
|---|
| 34 | |
|---|
| 35 | Usage |
|---|
| 36 | ..:: -- -- -- -- -- -- -- -- -- -- ::.. |
|---|
| 37 | |
|---|
| 38 | IMPORTANT: Link 'AddressBook.framework' |
|---|
| 39 | (available on the Mac-computer self) to |
|---|
| 40 | your project, |
|---|
| 41 | since this CMCrashReporter is using this. |
|---|
| 42 | |
|---|
| 43 | 1) Link the classes and the nib-file to your project. |
|---|
| 44 | 2) link the addressbook.framework to your project (available on Mac OS Library) |
|---|
| 45 | 3) At your main-class (preferable AppDelegate) |
|---|
| 46 | import CMCrashReporter.h and call [CMCrashReporter check]. |
|---|
| 47 | |
|---|
| 48 | A good place to call this method is in -(void)applicationDidFinishLaunching: in your app delegate |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | |
|---|
| 52 | App Settings (info.plist) |
|---|
| 53 | ..:: -- -- -- -- -- -- -- -- -- -- ::.. |
|---|
| 54 | |
|---|
| 55 | CMSubmitURL - String: HTTP-Path to commit the logs to (as POST-Data) |
|---|
| 56 | CMMaxReports (optional) - Int: max number of crashlogs to be sent |
|---|
| 57 | |
|---|
| 58 | Settings (Preferences) |
|---|
| 59 | ..:: -- -- -- -- -- -- -- -- -- -- ::.. |
|---|
| 60 | It's possible to let your users have a choice to submit reports, or just ignore them. |
|---|
| 61 | |
|---|
| 62 | Create a NSCheckbox and link this to NSUserDefaults with 'CMCrashReporterIgnoreCrashes' as key. |
|---|
| 63 | |
|---|
| 64 | CMCrashReporterIgnoreCrashes - BOOL: let the user ignore crashreports |
|---|
