AsyncDisplayKit/_site/docs/installation.html

<!DOCTYPE html>
<html prefix="og: http://ogp.me/ns#">
<head>
    <meta charset='utf-8'>
    <title>AsyncDisplayKit | Installation</title>
    <link rel='stylesheet' href='/static/main.css' type='text/css'/>
    <link rel="stylesheet" href='/static/pygments.css' type='text/css'/>
    <link rel='shortcut icon' href='/static/favicon.png'>
    <meta name='viewport' content='width=480'>
    <meta property="og:title" content="Installation" />
    <meta property="og:site_name" content="AsyncDisplayKit">
    <meta property='og:description' content='AsyncDisplayKit: A Library for Functional UI on iOS.'>
    <meta property='og:image' content='http://asyncdisplaykit.org/static/asyncdisplaykit-og-image.png'>
    <meta property='og:url' content="http://asyncdisplaykit.org/docs/installation.html">
    <meta property='og:type' content='website'>
    <script type="text/javascript" src="//use.typekit.net/vqa1hcx.js"></script>
    <script type="text/javascript">{'try{Typekit.load();}catch(e){}'}</script>
</head>
<body>

<header class='topbar site-header'><nav class='width'>
<a class="site-title" href="/">AsyncDisplayKit</a>
    <ul>
      <li><a href="/docs/getting-started.html"  class="active" >
          docs
      </a></li>
      <li><a href="/appledocs.html" >api</a></li>
      <li><a href="/resources.html" >resources</a></li>
      <li><a href="http://github.com/facebook/AsyncDisplayKit">github</a>
    </ul>
</nav></header>


<section class='content'><div class='width'>

<nav class='toc'>

    <section>
      <h3>Quick Start</h3>
      <ul>


            <li>
              <a href=/docs/getting-started.html>
                Getting Started
              </a>
            </li>


            <li>
              <a href=/docs/philosophy.html>
                Philosophy
              </a>
            </li>


            <li>
              <a href=/docs/installation.html class="active">
                Installation
              </a>
            </li>


            <li>
              <a href=/docs/references.html>
                References
              </a>
            </li>


      </ul>
    </section>

    <section>
      <h3>Core Concepts</h3>
      <ul>


            <li>
              <a href=/docs/intelligent-preloading.html>
                Intelligent Preloading
              </a>
            </li>


            <li>
              <a href=/docs/subclassing.html>
                Subclassing
              </a>
            </li>


            <li>
              <a href=/docs/layout-engine.html>
                Layout Engine
              </a>
            </li>


      </ul>
    </section>

    <section>
      <h3>Node Containers</h3>
      <ul>


            <li>
              <a href=/docs/asviewcontroller.html>
                ASViewController
              </a>
            </li>


            <li>
              <a href=/docs/aspagernode.html>
                ASPagerNode
              </a>
            </li>


            <li>
              <a href=/docs/ascollectionnode.html>
                ASCollectionNode
              </a>
            </li>


            <li>
              <a href=/docs/astablenode.html>
                ASTableNode
              </a>
            </li>


      </ul>
    </section>

    <section>
      <h3>Nodes</h3>
      <ul>


            <li>
              <a href=/docs/display-node.html>
                ASDisplayNode
              </a>
            </li>


            <li>
              <a href=/docs/cell-node.html>
                ASCellNode
              </a>
            </li>


            <li>
              <a href=/docs/text-cell-node.html>
                ASTextCellNode
              </a>
            </li>


            <li>
              <a href=/docs/control-node.html>
                ASControlNode
              </a>
            </li>


            <li>
              <a href=/docs/button-node.html>
                ASButtonNode
              </a>
            </li>


            <li>
              <a href=/docs/text-node.html>
                ASTextNode
              </a>
            </li>


            <li>
              <a href=/docs/editable-text-node.html>
                ASEditableTextNode
              </a>
            </li>


            <li>
              <a href=/docs/image-node.html>
                ASImageNode
              </a>
            </li>


            <li>
              <a href=/docs/network-image-node.html>
                ASNetworkImageNode
              </a>
            </li>


            <li>
              <a href=/docs/map-node.html>
                ASMapNode
              </a>
            </li>


            <li>
              <a href=/docs/video-node.html>
                ASVideoNode
              </a>
            </li>


            <li>
              <a href=/docs/scroll-node.html>
                ASScrollNode
              </a>
            </li>


      </ul>
    </section>

    <section>
      <h3>Layout Engine</h3>
      <ul>


            <li>
              <a href=/docs/automatic-layout-basics.html>
                Layout Basics
              </a>
            </li>


            <li>
              <a href=/docs/automatic-layout-containers.html>
                Layout Containers
              </a>
            </li>


            <li>
              <a href=/docs/automatic-layout-examples.html>
                Layout Examples
              </a>
            </li>


            <li>
              <a href=/docs/automatic-layout-debugging.html>
                Layout Debugging
              </a>
            </li>


            <li>
              <a href=/docs/layout-options.html>
                Layout Options
              </a>
            </li>


      </ul>
    </section>

    <section>
      <h3>Optimizations</h3>
      <ul>


            <li>
              <a href=/docs/layer-backing.html>
                Layer Backing
              </a>
            </li>


            <li>
              <a href=/docs/synchronous-concurrency.html>
                Synchronous Concurrency
              </a>
            </li>


            <li>
              <a href=/docs/subtree-rasterization.html>
                Subtree Rasterization
              </a>
            </li>


            <li>
              <a href=/docs/drawing-priority.html>
                Drawing Priority
              </a>
            </li>


      </ul>
    </section>

    <section>
      <h3>Conveniences</h3>
      <ul>


            <li>
              <a href=/docs/hit-test-slop.html>
                Hit Test Slop
              </a>
            </li>


            <li>
              <a href=/docs/image-modification-block.html>
                Image Modification Blocks
              </a>
            </li>


            <li>
              <a href=/docs/placeholder-fade-duration.html>
                Placeholder Fade Duration
              </a>
            </li>


      </ul>
    </section>

    <section>
      <h3>Debug Tools</h3>
      <ul>


            <li>
              <a href=/docs/debug-tool-pixel-scaling.html>
                Image Scaling
              </a>
            </li>


            <li>
              <a href=/docs/debug-tool-hit-test-slop.html>
                Hit Test Visualization
              </a>
            </li>


            <li>
              <a href=/docs/debug-tool-ASRangeController.html>
                Range Visualization
              </a>
            </li>


      </ul>
    </section>

</nav>


<article class='withtoc'>
    <h1>
      Installation
      <a class="edit-page-link" href="https://github.com/facebook/asyncdisplaykit/tree/gh-pages/_docs/installation.md" target="_blank">Edit on GitHub</a>
    </h1>
    <p></p>

    <h3>CocoaPods</h3>

<p>ASDK is available on <a href="http://cocoapods.org">CocoaPods</a>.  Add the following to your Podfile:</p>
<div class="highlight"><pre><code class="language-objective-c" data-lang="objective-c"><span class="n">pod</span> <span class="err">&#39;</span><span class="n">AsyncDisplayKit</span><span class="err">&#39;</span>
</code></pre></div>
<p>ASDK can also be used as a regular static library:  </p>

<p>Copy the project to your codebase manually, adding <code>AsyncDisplayKit.xcodeproj</code> to your workspace. Add <code>libAsyncDisplayKit.a</code>, AssetsLibrary, and Photos to the &quot;Link Binary With Libraries&quot; build phase.  Include <code>-lc++ -ObjC</code> in your project linker flags.</p>

<p>Import the framework header, or create an <a href="https://developer.apple.com/library/ios/documentation/swift/conceptual/buildingcocoaapps/MixandMatch.html">Objective-C bridging header</a> if you&#39;re using <strong>Swift</strong>:</p>
<div class="highlight"><pre><code class="language-objective-c" data-lang="objective-c"><span class="cp">#import &lt;AsyncDisplayKit/AsyncDisplayKit.h&gt;</span>
</code></pre></div>
<h3>Carthage</h3>

<p>ASDK is available through <a href="https://github.com/Carthage/Carthage">Carthage</a>. Add the following to your Cartfile:</p>
<div class="highlight"><pre><code class="language-objective-c" data-lang="objective-c"><span class="n">github</span> <span class="s">&quot;facebook/AsyncDisplayKit&quot;</span>
</code></pre></div>
<p>Run ‘carthage update’ in Terminal and to fetch and build the ASDK library. This will create a folder named Carthage in your app’s root folder. In that folder there will be a ‘Build’ folder from where you have to drag the frameworks you want to use into the “Linked Frameworks and Libraries” section in Xcode.</p>

<p>Learn more about <a href="https://github.com/Carthage/Carthage/blob/master/README.md">Carthage</a>.</p>


    <div class="docs-prevnext">


        <a class="right" href="/docs/references.html">Next &rarr;</a>

    </div>

    <a id="_"></a>
</article>

</div></section>
<footer class="copyright"-><div class='width'>
a Facebook &amp; Instagram collaboration &#x2665;
</div></footer>

<script src="/static/linkify.js"></script>
<script>
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
    m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  ga('create', 'UA-44373548-4', 'auto');
  ga('send', 'pageview');

  !function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="https://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");
</script>
</body>
</html>