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 <h1><a name="NativeClient_Documentation_trust" id="NativeClient_Documentation_trust"> </a> Native Client: README </h1>
  18
  19 <p>
  20 Welcome to the Native Client distribution.
  21 This README file has the following sections:
  22 </p>
  23
  24 <ul>
  25 <li><a href="#doc">Documentation</a></li>
  26 <li><a href="#directory">Directory structure</a></li>
  27 </ul>
  28
  29 <p>
  30 For the latest information about Native Client, see the
  31 <a href="http://code.google.com/p/nativeclient">Native Client project page</a>.
  32 </p>
  33
  34
  35 <h2><a name="doc" id="doc"> </a> Documentation </h2>
  36 <p> This release of Native Client contains the following documentation: </p>
  37 <ul>
  38   <li> How tos
  39     <ul>
  40         <li> <a href="documentation/getting_started.html">Getting Started</a>
  41         - A guide to running example modules and building your own </li>
  42       <li> <a href="documentation/building.html">Building Native Client</a>
  43       - How to build Native Client, including its demos and tests </li>
  44       <li> <a href="documentation/debugging.html">Debugging Tips</a>
  45       - How to debug your Native Client modules </li>
  46     </ul>
  47   </li>
  48   <li> APIs
  49     <ul>
  50         <li> API Overview - An overview of the APIs available
  51         to Native Client modules;
  52         for now, see the
  53         <a href="scons-out/doc/html/index.html">API Reference</a> </li>
  54         <li> <a href="documentation/npapi.html">NPAPI Support</a>
  55          - Information about which NPAPI functions are supported
  56            for use in Native Client modules </li>
  57         <li> <a href="scons-out/doc/html/index.html">API Reference</a>
  58         - Automatically generated reference documentation for
  59         APIs defined by Native Client </li>
  60     </ul>
  61   </li>
  62   <li> And more
  63     <ul>
  64       <li> <a href="documentation/examples.html">Examples and Tests</a> - A guide to our sample Native Client modules </li>
  65       <li> <a href="documentation/nacl_paper.pdf">Native Client: A Sandbox for Portable, Untrusted x86 Native Code</a> [PDF]
  66       - A research paper about the design, implementation, and evaluation of Native Client</li>
  67     </ul>
  68   </li>
  69 </ul>
  70
  71
  72 <h2><a name="directory" id="directory"> </a> Directory structure </h2>
  73
  74 <p>
  75 The distribution for each platform (Linux, Mac, or Windows)
  76 contains the following:
  77 </p>
  78
  79 <ul>
  80   <li> A pre-built SDK for that platform </li>
  81   <li> Pre-built binaries for the Firefox plug-in,
  82        the <code>sel_ldr</code> test container,
  83        and a set of example and test programs</li>
  84   <li> Complete, buildable source
  85        that's portable across all three operating systems</li>
  86   <li> Documentation, including the
  87        <a href="documentation/getting_started.html">Getting Started</a> guide
  88        </li>
  89 </ul>
  90
  91 <p>
  92 Although the documentation is incomplete,
  93 you should be able to find what you need by looking at the the source code.
  94 The following table describes major files and directories
  95 in the release.
  96 Paths are relative to the
  97 <code>nacl/googleclient/native_client</code> directory.
  98 </p>
  99
 100 <table>
 101   <tbody>
 102     <tr>
 103       <th>File or directory</th>
 104       <th>Description</th>
 105     </tr>
 106     <tr>
 107       <td><pre class="listing">
 108 <a href="../VERSION">../VERSION</a>
 109 <a href="COPYING">COPYING</a>
 110 <a href="NOTICE">NOTICE</a>
 111 README.html <em>(this file)</em>
 112 <a href="RELEASE_NOTES">RELEASE_NOTES</a>
 113 <a href="./documentation/">documentation/</a>
 114 </pre></td>
 115       <td>Documentation, release, and license information.</td>
 116     </tr>
 117     <tr>
 118       <td><pre class="listing">
 119 <a href="./common/">common/</a>
 120 <a href="./tests/">tests/</a>
 121 </pre></td>
 122       <td> Source code for <a href="documentation/examples.html">examples and tests</a>. </td>
 123     </tr>
 124
 125     <tr>
 126       <td><pre class="listing">
 127 SConstruct
 128 scons.bat
 129 scons
 130 <a href="./scons-out/">scons-out/</a>
 131 <a href="./site_scons/">site_scons/</a>
 132 </pre></td>
 133       <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,
 134            examples, and tests.</p>      </td>
 135     </tr>
 136
 137     <tr>
 138       <td><pre class="listing">
 139 <a href="./include/">include/</a>
 140 <a href="./intermodule_comm/">intermodule_comm/</a>
 141 <a href="./ncv/">ncv/</a>
 142 <a href="./nonnacl_util/">nonnacl_util/</a>
 143 <a href="./npapi_plugin/">npapi_plugin/</a>
 144 <a href="./service_runtime/">service_runtime/</a>
 145 </pre></td>
 146       <td>Core source code.
 147         <code>include</code> contains header files
 148         that are missing from some platforms
 149         and are used by more than one major module.
 150         <code>intermodule_comm</code> implements the lower-level abstractions
 151         of the IMC interface.
 152         <code>ncv</code> implements the validator.
 153         <code>nonnacl_util</code> contains utilities
 154           used by by the plug-in to launch <code>sel_ldr</code>.
 155         <code>npapi_plugin</code> is the Native Client plug-in.
 156         <code>service_runtime</code> is the core of Native Client. </td>
 157     </tr>
 158     <tr>
 159       <td><pre class="listing">
 160 <a href="./gtest/">gtest/</a>
 161 </pre></td>
 162       <td>Google open source unit testing framework,
 163       used for <code>service_runtime</code> unit tests.
 164     </tr>
 165     <tr>
 166       <td><pre class="listing">
 167 <a href="./platform_qual_test/">platform_qual_test/</a>
 168 </pre></td>
 169       <td>Platform Qualification Test V0.1.
 170           Used by <code>sel_ldr</code>
 171           to verify that the current machine and OS
 172           meet the minimum requirements
 173           for running Native Client modules.
 174       </td>
 175     </tr>
 176     <tr>
 177       <td><pre class="listing">
 178 <a href="../third_party/">../third_party/</a>
 179 <a href="./third_party/">third_party/</a>
 180 </pre></td>
 181       <td>Third-party source code and
 182       (in <a href="../third_party/nacl_sdk/"><code>../third_party/nacl_sdk/</code></a>)
 183       a pre-built Native Client SDK.</td>
 184     </tr>
 185
 186     <tr>
 187       <td><pre class="listing">
 188 <a href="./tools/">tools/</a>
 189 </pre></td>
 190       <td> Source code for the Native Client SDK.</td>
 191     </tr>
 192
 193   </tbody>
 194 </table>
 195
 196 <p id="license">
 197 Except as otherwise
 198 <a href="http://code.google.com/policies.html#restrictions">noted</a>,
 199 the content of this page is licensed under a
 200 <a href="http://www.google.com/url?sa=D&amp;q=http%3A%2F%2Fcreativecommons.org/licenses/by/2.5/">Creative Commons
 201 Attribution 2.5 license</a>.
 202 </p>
 203
 204 </body>
 205 </html>