README.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3 <!-- NOTE: Follow the steps in documentation/getting_started.html. -->
   4 <!--       Also see http://code.google.com/p/nativeclient.         -->
   5 <!--                                                               -->
   6 <!-- The latest version of this file is viewable online at:        -->
   7 <!-- http://nativeclient.googlecode.com/svn/trunk/nacl/googleclient/native_client/README.html                                                      -->
   8
   9 <html xmlns="http://www.w3.org/1999/xhtml">
  10 <head>
  11 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  12 <title>Native Client: README</title>
  13 <link href="documentation/stylesheet.css" type="text/css" rel="stylesheet"></link>
  14 </head>
  15
  16 <body>
  17
  18 <!-- start: CSE gadget -->
  19 <div style="padding-top:5px; padding-bottom:5px; align:right; float: right;">
  20 <form action="http://www.google.com/cse" id="cse-search-box" target="_blank">
  21 <div>
  22 <input type="hidden" name="cx" value="002967670403910741006:qhab5lo7cqo" />
  23 <input type="hidden" name="ie" value="UTF-8" />
  24 <input type="text" name="q" size="28" />
  25 <input type="submit" name="sa" value="Search" />
  26 <div style="font-size:75%">
  27 Search Native Client webpages
  28 </div>
  29 </div>
  30 </form>
  31 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&amp;lang=en"></script>
  32 <script>_IG_AdjustIFrameHeight();</script>
  33 </div>
  34 <!-- end: CSE gadget -->
  35
  36 <h1><a name="NativeClient_Documentation_trust" id="NativeClient_Documentation_trust"> </a> Native Client: README </h1>
  37
  38 <p>
  39 Welcome to the Native Client distribution.
  40 This README file has the following sections:
  41 </p>
  42
  43 <ul>
  44 <li><a href="#doc">Documentation</a></li>
  45 <li><a href="#directory">Directory structure</a></li>
  46 </ul>
  47
  48 <p>
  49 For the latest information about Native Client, see the
  50 <a href="http://code.google.com/p/nativeclient">Native Client project page</a>.
  51 </p>
  52
  53
  54 <h2><a name="doc" id="doc"> </a> Documentation </h2>
  55 <p> This release of Native Client contains the following documentation: </p>
  56 <ul>
  57   <li> How tos
  58     <ul>
  59         <li> <a href="documentation/getting_started.html">Getting Started</a>
  60         - A guide to running example modules and building your own </li>
  61       <li> <a href="documentation/building.html">Building Native Client</a>
  62       - How to build Native Client, including its demos and tests </li>
  63       <li> <a href="documentation/debugging.html">Debugging Tips</a>
  64       - How to debug your Native Client modules </li>
  65     </ul>
  66   </li>
  67   <li> APIs
  68     <ul>
  69         <li> <a href="scons-out/doc/html/index.html">API Reference</a>
  70         - Automatically generated reference documentation for
  71         APIs defined by Native Client </li>
  72         <li> <a href="documentation/npapi.html">NPAPI Support</a>
  73          - Information about which NPAPI functions are supported
  74            for use in Native Client modules </li>
  75     </ul>
  76   </li>
  77   <li> And more
  78     <ul>
  79       <li> <a href="documentation/examples.html">Examples and Tests</a> - A guide to our sample Native Client modules </li>
  80       <li> <a href="documentation/nacl_paper.pdf">Native Client: A Sandbox for Portable, Untrusted x86 Native Code</a> [PDF]
  81       - A research paper about the design, implementation, and evaluation of Native Client</li>
  82       <li> Platform-specific details for
  83         <a href="documentation/platform-linux.html">Linux</a>,
  84         <a href="documentation/platform-mac.html">Mac</a>, and
  85         <a href="documentation/platform-windows.html">Windows</a>. </li>
  86
  87     </ul>
  88   </li>
  89 </ul>
  90
  91
  92 <h2><a name="directory" id="directory"> </a> Directory structure </h2>
  93
  94 <p>
  95 The distribution for each platform (Linux, Mac, or Windows)
  96 contains the following:
  97 </p>
  98
  99 <ul>
 100   <li> A pre-built SDK for that platform </li>
 101   <li> Pre-built binaries for the Firefox plug-in,
 102        the <code>sel_ldr</code> test container,
 103        and a set of example and test programs</li>
 104   <li> Complete, buildable source
 105        that's portable across all three operating systems</li>
 106   <li> Documentation, including the
 107        <a href="documentation/getting_started.html">Getting Started</a> guide
 108        </li>
 109 </ul>
 110
 111 <p>
 112 Although the documentation is incomplete,
 113 you should be able to find what you need by looking at the the source code.
 114 The following table describes major files and directories
 115 in the release.
 116 Paths are relative to the
 117 <code>nacl/googleclient/native_client</code> directory.
 118 </p>
 119
 120 <table>
 121   <tbody>
 122     <tr>
 123       <th>File or directory</th>
 124       <th>Description</th>
 125     </tr>
 126     <tr>
 127       <td><pre class="listing">
 128 <a href="../VERSION">../VERSION</a>
 129 <a href="COPYING">COPYING</a>
 130 <a href="NOTICE">NOTICE</a>
 131 README.html <em>(this file)</em>
 132 <a href="RELEASE_NOTES">RELEASE_NOTES</a>
 133 <a href="./documentation/">documentation/</a>
 134 </pre></td>
 135       <td>Documentation, release, and license information.</td>
 136     </tr>
 137     <tr>
 138       <td><pre class="listing">
 139 <a href="./common/">common/</a>
 140 <a href="./tests/">tests/</a>
 141 </pre></td>
 142       <td> Source code for <a href="documentation/examples.html">examples and tests</a>. </td>
 143     </tr>
 144
 145     <tr>
 146       <td><pre class="listing">
 147 SConstruct
 148 scons.bat
 149 scons
 150 <a href="./scons-out/">scons-out/</a>
 151 <a href="./site_scons/">site_scons/</a>
 152 </pre></td>
 153       <td><p>Build-related files. In each tarball, <code>scons-out/*/staging</code> directories contain files that let you use and test the Native Client plug-in. The <code>scons.bat</code> and <code>scons</code> files let you  <a href="documentation/building.html">build</a> Native Client,
 154            examples, and tests.</p>      </td>
 155     </tr>
 156
 157     <tr>
 158       <td><pre class="listing">
 159 <a href="./include/">include/</a>
 160 <a href="./intermodule_comm/">intermodule_comm/</a>
 161 <a href="./ncv/">ncv/</a>
 162 <a href="./nonnacl_util/">nonnacl_util/</a>
 163 <a href="./npapi_plugin/">npapi_plugin/</a>
 164 <a href="./service_runtime/">service_runtime/</a>
 165 </pre></td>
 166       <td>Core source code.
 167         <code>include</code> contains header files
 168         that are missing from some platforms
 169         and are used by more than one major module.
 170         <code>intermodule_comm</code> implements the lower-level abstractions
 171         of the IMC interface.
 172         <code>ncv</code> implements the validator.
 173         <code>nonnacl_util</code> contains utilities
 174           used by by the plug-in to launch <code>sel_ldr</code>.
 175         <code>npapi_plugin</code> is the Native Client plug-in.
 176         <code>service_runtime</code> is the core of Native Client. </td>
 177     </tr>
 178     <tr>
 179       <td><pre class="listing">
 180 <a href="./gtest/">gtest/</a>
 181 </pre></td>
 182       <td>Google open source unit testing framework,
 183       used for <code>service_runtime</code> unit tests.
 184     </tr>
 185     <tr>
 186       <td><pre class="listing">
 187 <a href="./platform_qual_test/">platform_qual_test/</a>
 188 </pre></td>
 189       <td>Platform Qualification Test V0.1.
 190           Used by <code>sel_ldr</code>
 191           to verify that the current machine and OS
 192           meet the minimum requirements
 193           for running Native Client modules.
 194       </td>
 195     </tr>
 196     <tr>
 197       <td><pre class="listing">
 198 <a href="../third_party/">../third_party/</a>
 199 <a href="./third_party/">third_party/</a>
 200 </pre></td>
 201       <td>Third-party source code and
 202       (in <a href="../third_party/nacl_sdk/"><code>../third_party/nacl_sdk/</code></a>)
 203       a pre-built Native Client SDK.</td>
 204     </tr>
 205
 206     <tr>
 207       <td><pre class="listing">
 208 <a href="./tools/">tools/</a>
 209 </pre></td>
 210       <td> Source code for the Native Client SDK.</td>
 211     </tr>
 212
 213   </tbody>
 214 </table>
 215
 216 <p id="license">
 217 Except as otherwise
 218 <a href="http://code.google.com/policies.html#restrictions">noted</a>,
 219 the content of this page is licensed under a
 220 <a href="http://www.google.com/url?sa=D&amp;q=http%3A%2F%2Fcreativecommons.org/licenses/by/2.5/">Creative Commons
 221 Attribution 2.5 license</a>.
 222 </p>
 223
 224 </body>
 225 </html>