doc/xcode_frameworks.rst: added page on xcode frameworks
authorPaul Brossier <piem@piem.org>
Fri, 26 Aug 2016 13:36:29 +0000 (15:36 +0200)
committerPaul Brossier <piem@piem.org>
Fri, 26 Aug 2016 13:36:29 +0000 (15:36 +0200)
doc/xcode_frameworks.rst [new file with mode: 0644]

diff --git a/doc/xcode_frameworks.rst b/doc/xcode_frameworks.rst
new file mode 100644 (file)
index 0000000..ee7ae59
--- /dev/null
@@ -0,0 +1,41 @@
+.. _xcode-frameworks-label:
+
+Using aubio frameworks in Xcode
+-------------------------------
+
+`Binary frameworks`_ are available and ready to use in your XCode project, for
+`iOS`_ and `macOS`_.
+
+#. Download the ``framework.zip`` file from the `Download`_ page.
+
+#. Select 'Build Phases' in your project settings
+
+#. Unfold the 'Link Binary with Libraries' list, and add 'AudioToolbox and
+   Accelerate frameworks
+
+#. Also add ``aubio.framework`` from https://aubio.org/download.
+
+#. Include the aubio header in your code:
+
+  * in C/C++:
+
+  .. code-block:: c
+
+    #include <aubio/aubio.h>
+
+  * in Obj-C:
+
+  .. code-block:: obj-c
+
+    #import <aubio/aubio.h>
+
+  * in Swift:
+
+  .. code-block:: swift
+
+    import aubio
+
+.. _Binary frameworks: https://aubio.org/download
+.. _iOS: https://aubio.org/download#ios
+.. _macOS: https://aubio.org/download#osx
+.. _Download: https://aubio.org/download