Commit 677b326c authored by Drew's avatar Drew

Better document the caroline install process

parent 288f7d90
Pipeline #2323 passed with stages
in 5 minutes and 58 seconds
......@@ -89,47 +89,53 @@ Downloading with atpm
1. Create a build.atpkg
.. code-block:: clojure
.. code-block:: clojure
(package
:name "YourProgram"
(package
:name "YourProgram"
:external-packages [
{
:version [">=0.1"]
:channels ["core-osx-swift-2.2" "core-ios-swift-2.2"]
:url "https://code.sealedabstract.com/drewcrawford/Caroline/raw/master/manifest.atpkg"
}
]
:external-packages [
{
:version [">=0.1"]
:channels ["core-osx-swift-2.2" "core-ios-swift-2.2"]
:url "https://code.sealedabstract.com/drewcrawford/Caroline/raw/master/manifest.atpkg"
}
]
.. note::
.. note::
Caroline supports the following channels. Choose the correct one(s) for your platform:
Caroline supports the following channels. Choose the correct one(s) for your platform:
* :code:`core-osx-swift-2.2` Swift 2.2, OSX
* :code:`core-ios-swift-2.2` Swift 2.2, iOS
* :code:`core-osx-swift-2.2` Swift 2.2, OSX
* :code:`core-ios-swift-2.2` Swift 2.2, iOS
2. Install atpm. See the documentation on `anarchytools.org <http://anarchytools.org>`_.
3. Tell atpm to install Caroline.
.. code-block:: bash
.. code-block:: bash
atpm fetch
atpm fetch
Caroline will be installed into :code:`external/Caroline/channels/[channel-name]`.
4. Check build.atlock into source control. This ensures the version of Caroline you were building with is tracked in source control.
4. Check :code:`build.atlock` into source control. This ensures the version of Caroline you were building with is tracked in source control. For more information on atlock, see the `anarchy tools documentation <http://anarchytools.org/docs/atlock.html>`_.
.. code-block:: bash
.. code-block:: bash
git add build.atlock && git commit -m "Add Caroline"
5. With :code:`build.atlock` checked in, we can ignore the whole :code:`external` directory, since dependency information is stored in :code:`build.atlock`.
.. code-block:: bash
git add build.atlock && git commit -m "Add Caroline"
echo "external" >> .gitignore
5. To update Caroline, use atpm.
6. To update Caroline, use atpm.
.. code-block::
.. code-block::
atpm update
atpm update
Installing Caroline into an Xcode project
++++++++++++++++++++++
......
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