Merge pull request beeware#126 from mcscope/patch-2

Add how-to guide for how to see errors on iOS.
amymok · Mar 19, 2019 · f4b18c0 · f4b18c0
2 parents 4288f46 + 9ff13c0
commit f4b18c0
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/docs/how-to/PyStackTraceOnXCode.png b/docs/how-to/PyStackTraceOnXCode.png
diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst
@@ -11,3 +11,4 @@ How-to guides are recipes that take the user through steps in key subjects. They
  :glob:
 
  Contribute to Briefcase <contribute>
+ See errors on iOS <see_errors_on_ios>
diff --git a/docs/how-to/see_errors_on_ios.rst b/docs/how-to/see_errors_on_ios.rst
@@ -0,0 +1,12 @@
+See Errors on iOS
+=========================
+
+If you have a beeware iOS project that has a crash, it can be difficult to see the stacktrace. Here's how to do it -
+
+1. Build your iOS project. You don't have to start it.
+
+2. Open that iOS project in Xcode. Click the Run button (looks like an arrow) and wait for the simulator to open. Cause the app to crash.
+
+3. Your stack trace ought to appear in the 'debugger area' at the bottom of the screen. If you can't see that area, you may have to activate it with ``View`` > ``Debug Area`` > ``Show Debug Area``
+
+ .. image:: PyStackTraceOnXCode.png