Commit 44cbcbed authored by Drew's avatar Drew

Improve documentation

We need to embed binaries on iOS/OSX Xcode platforms.

Also making some notes about test target / app target to reduce confusion.
parent 8a497f67
......@@ -11,6 +11,12 @@ Caroline has two parts; the :term:`static tool` and the :term:`framework`.
framework
The Caroline test engine itself, compiled and linked with your code.
app target
The application being tested.
test target
A target containing (only) your tests.
Installing the static tool
--------------------------
......@@ -136,7 +142,7 @@ Regardless of how you download Caroline, it can be integrated into your Xcode pr
<video controls src="_static/drag-framework.m4v" width="75%"></video>
2. Create a build script phase in your test target with these contents:
2. Create a build script phase in your :term:`test target` with these contents:
.. code-block:: bash
......@@ -150,7 +156,7 @@ Regardless of how you download Caroline, it can be integrated into your Xcode pr
.. warning::
Make sure you create this script phase in your **test target**, not your **app target**.
Make sure you create this script phase in your :term:`test target`, not your :term:`app target`.
3. Press Cmd-U. The test will fail to build, but a new source file `CarolineXCTest.swift` will be generated.
......@@ -160,7 +166,27 @@ Regardless of how you download Caroline, it can be integrated into your Xcode pr
<video controls src="_static/carolinexctest.m4v" width="75%"></video>
5. Press Cmd-U. Your tests should run and pass successfully.
5. Embed binaries. The instructions depend on your platform:
a. iOS
If you are testing an iOS application, you must add Caroline as an "embedded binary" to your :term:`app target`. (**Not** your :term:`test target`.)
If you are testing an iOS framework, you must have a host application as an :term:`app target`, even if it does nothing.
.. image:: _static/embed.png
:width: 80%
b. OSX
If you are testing an OSX application, you must add Caroline to your "Copy Files" phase of your :term:`test target`. (**Not** your :term:`app target`.)
.. image:: _static/embed-osx.png
:width: 80%
6. Press Cmd-U. Your tests should run and pass successfully.
For projects built with AnarchyTools
______________________________________
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment