Commit b1d9f78d authored by Drew's avatar Drew

Document installing OSX static tool

parent 8a1376f8
Pipeline #2247 passed with stages
in 2 minutes and 10 seconds
...@@ -15,9 +15,28 @@ Caroline has two parts; the :term:`static tool` and the :term:`framework`. ...@@ -15,9 +15,28 @@ Caroline has two parts; the :term:`static tool` and the :term:`framework`.
Installing the static tool Installing the static tool
-------------------------- --------------------------
OSX
_____
To install the static tool on OSX, add Drew's tap:
.. code-block:: bash
brew tap drewcrawford/drew https://code.sealedabstract.com/drewcrawford/drew-homebrew.git
And then install the static tool:
.. code-block:: bash
brew install caroline-static-tool
Linux
_____
.. todo:: .. todo::
install static tool install static tool on Linux
...@@ -45,7 +64,7 @@ With Xcode, we run the Caroline engine inside a single XCTest. This lets you mi ...@@ -45,7 +64,7 @@ With Xcode, we run the Caroline engine inside a single XCTest. This lets you mi
2. Create a build script phase in your test target with these contents: 2. Create a build script phase in your test target with these contents:
.. code:: bash .. code-block:: bash
caroline-static-tool caroline-static-tool
...@@ -90,7 +109,7 @@ ______________________________________ ...@@ -90,7 +109,7 @@ ______________________________________
1. Add the Caroline source to your external-packages in :code:`build.atpkg` 1. Add the Caroline source to your external-packages in :code:`build.atpkg`
.. code:: clojure .. code-block:: clojure
:external-packages [ :external-packages [
{ {
...@@ -101,7 +120,7 @@ ______________________________________ ...@@ -101,7 +120,7 @@ ______________________________________
2. Create a task to generate your tests. 2. Create a task to generate your tests.
.. code:: clojure .. code-block:: clojure
:gen-tests { :gen-tests {
:tool "shell" :tool "shell"
...@@ -111,7 +130,7 @@ ______________________________________ ...@@ -111,7 +130,7 @@ ______________________________________
3. Create a task to build your tests. 3. Create a task to build your tests.
.. code:: clojure .. code-block:: clojure
:build-tests { :build-tests {
:tool "atllbuild" :tool "atllbuild"
...@@ -129,7 +148,7 @@ ______________________________________ ...@@ -129,7 +148,7 @@ ______________________________________
4. Create a task to run your tests. 4. Create a task to run your tests.
.. code:: clojure .. code-block:: clojure
:check { :check {
:tool "shell" :tool "shell"
......
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