src/native_client/README.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional" "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/src/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 </div>
  33 <!-- end: CSE gadget -->
  34
  35 <h1><a name="NativeClient_Documentation_trust" id="NativeClient_Documentation_trust"> </a> Native Client: README </h1>
  36
  37 <p>
  38 Welcome to Native Client.
  39 This README file has the following sections:
  40 </p>
  41
  42 <ul>
  43 <li><a href="#doc">Documentation</a></li>
  44 <li><a href="#directory">Directory structure</a></li>
  45 </ul>
  46
  47 <p>
  48 For the latest information about Native Client, see the
  49 <a href="http://code.google.com/p/nativeclient">Native Client project page</a>.
  50 </p>
  51
  52
  53 <h2><a name="doc" id="doc"> </a> Documentation </h2>
  54 <p> The Native Client project contains the following documentation: </p>
  55 <ul>
  56   <li> How tos
  57     <ul>
  58         <li> <a href="documentation/getting_started.html">Getting Started</a>
  59         - A guide to running example modules and building your own </li>
  60       <li> <a href="documentation/building.html">Building Native Client</a>
  61       - How to build Native Client, including its demos and tests </li>
  62       <li> <a href="documentation/debugging.html">Debugging Tips</a>
  63       - How to debug your Native Client modules
  64         <ul>
  65           <li> <a href="documentation/nacl-gdb.html">nacl-gdb</a>
  66           - How to use the debugger (Linux only) </li>
  67         </ul> </li>
  68     </ul>
  69   </li>
  70   <li> APIs
  71     <ul>
  72         <li> <a href="scons-out/doc/html/index.html">API Reference</a>
  73         - Automatically generated reference documentation for
  74         APIs defined by Native Client; if the preceding link doesn't work,
  75         read the
  76         <a href="http://nativeclient.googlecode.com/svn/data/docs_tarball/nacl/googleclient/native_client/scons-out/doc/html/index.html">online API reference documentation</a> </li>
  77         <li> <a href="documentation/npapi.html">NPAPI Support</a>
  78          - Information about which NPAPI functions are supported
  79            for use in Native Client modules </li>
  80     </ul>
  81   </li>
  82   <li> And more
  83     <ul>
  84       <li> <a href="documentation/examples.html">Examples and Tests</a> - A guide to our sample Native Client modules </li>
  85       <li> <a href="documentation/nacl_paper.pdf">Native Client: A Sandbox for Portable, Untrusted x86 Native Code</a> [PDF]
  86       - A research paper about the design, implementation, and evaluation of Native Client</li>
  87       <li> Platform-specific details for
  88         <a href="documentation/platform-linux.html">Linux</a>,
  89         <a href="documentation/platform-mac.html">Mac</a>, and
  90         <a href="documentation/platform-windows.html">Windows</a>. </li>
  91
  92     </ul>
  93   </li>
  94 </ul>
  95
  96
  97 <h2><a name="directory" id="directory"> </a> Directory structure </h2>
  98
  99 <p>
 100 You can get Native Client in two ways:
 101 </p>
 102
 103 <ul>
 104 <li> <a href="http://code.google.com/p/nativeclient/source/checkout">Download source code</a>
 105      from the SVN repository,
 106      so you can keep up with the very latest changes.
 107      Once you have the source code,
 108      build it as described in
 109      <a href="./documentation/getting_started.html">Getting Started</a>.
 110      (If those instructions are out of date, try the
 111      <a href="http://nativeclient.googlecode.com/svn/trunk/src/native_client/documentation/getting_started.html">latest online instructions</a>.)
 112      </li>
 113 <li> <a href="http://code.google.com/p/nativeclient/wiki/Downloads?tm=2">Download a tarball</a>
 114      that includes pre-built binaries for Linux, Mac, or Windows.
 115      This is the easiest way to get started using Native Client,
 116      but the binaries are based on old source code.
 117      For information about what the current tarball contains and
 118      how to get started using it, go to
 119      <a href="http://code.google.com/p/nativeclient/">http://code.google.com/p/nativeclient/</a>
 120      and click <b>Documentation / README</b> in the right column.
 121      </li>
 122 </ul>
 123
 124 <p>
 125 The following table describes major files and directories that you'll see
 126 in your working copy of the SVN repository,
 127 including some directories that don't exist until you've built Native Client.
 128 Paths are relative to the
 129 <code>native_client</code> directory.
 130 </p>
 131
 132 <table summary="major files and directories">
 133   <tbody>
 134     <tr>
 135       <th>File or directory</th>
 136       <th>Description</th>
 137     </tr>
 138     <tr>
 139       <td><pre class="listing">
 140 <!-- a href="VERSION" -->VERSION<!-- /a --> <span class="comment">[PENDING: this file is currently AWOL] </span>
 141 <a href="COPYING">COPYING</a>
 142 <a href="NOTICE">NOTICE</a>
 143 README.html <em>(this file)</em>
 144 <a href="RELEASE_NOTES">RELEASE_NOTES</a>
 145 <a href="./documentation/">documentation/</a>
 146 </pre></td>
 147       <td>Documentation, release, and license information.</td>
 148     </tr>
 149
 150     <tr>
 151       <td><pre class="listing">
 152 SConstruct
 153 scons.bat
 154 scons
 155 <a href="./scons-out/">scons-out/</a> <em>(not in SVN)</em>
 156 <a href="./site_scons/">site_scons/</a> <em>(not in SVN)</em>
 157 </pre></td>
 158       <td><p>
 159       Build-related files.
 160       The <code>scons.bat</code> and <code>scons</code> files,
 161       with data from <code>SConstruct</code>,
 162       let you <a href="documentation/building.html">build</a>
 163       Native Client and its tests.
 164       The <code>scons-out</code> and <code>site-scons</code>
 165       directories don't exist in the SVN repository;
 166       they're created when Native Client is built.
 167       The <code>scons-out/*/staging</code> directories contain files,
 168       such as the Native Client plug-in and compiled examples,
 169       that let you use and test Native Client.
 170       </p>
 171       </td>
 172     </tr>
 173
 174     <tr>
 175       <td><pre class="listing">
 176 <a href="./src/">src/</a>
 177 <!--
 178 <a href="./src/include/">src/include/</a>
 179 <a href="./src/shared/">src/shared/</a>
 180 <a href="./src/trusted/">src/trusted/</a>
 181 <a href="./src/untrusted/">src/untrusted/</a> -->
 182 </pre></td>
 183       <td>Core source code for Native Client.
 184       <ul>
 185         <li> <code><a href="./src/include/">src/include/</a></code>:
 186           header files that are missing from some platforms
 187           and are used by more than one major part of Native Client </li>
 188         <li> <code><a href="./src/shared/">src/shared/</a></code>:
 189           source code that's used
 190           by both trusted code (such as the service runtime)
 191           and untrusted code (such as Native Client modules) </li>
 192         <li> <code><a href="./src/third_party/">src/third_party/</a></code>:
 193           other people's source code </li>
 194           <li> <code><a href="./src/trusted/">src/trusted/</a></code>:
 195           source code that's used
 196           only by trusted code </li>
 197           <li> <code><a href="./src/untrusted/">src/untrusted/</a></code>:
 198           source code that's used
 199           only by untrusted code </li>
 200         </ul>
 201         </td>
 202     </tr>
 203
 204     <tr>
 205       <td><pre class="listing">
 206 <a href="./tests/">tests/</a>
 207 <a href="./common/">common/</a>
 208 </pre></td>
 209       <td> Source code for <a href="documentation/examples.html">examples and tests</a>. </td>
 210     </tr>
 211
 212     <tr>
 213       <td><pre class="listing">
 214 <a href="../third_party/">../third_party/</a>
 215 </pre></td>
 216       <td>Third-party source code and binaries
 217       that aren't part of the service runtime.
 218       When built, the Native Client toolchain is in
 219       <a href="src/third_party/nacl_sdk/"><code>src/third_party/nacl_sdk/</code></a>.
 220       </td>
 221     </tr>
 222
 223     <tr>
 224       <td><pre class="listing">
 225 <a href="./tools/">tools/</a>
 226 </pre></td>
 227       <td> Utilities such as the plug-in installer.</td>
 228     </tr>
 229
 230   </tbody>
 231 </table>
 232
 233 <p id="license">
 234 Except as otherwise
 235 <a href="http://code.google.com/policies.html#restrictions">noted</a>,
 236 the content of this page is licensed under a
 237 <a href="http://www.google.com/url?sa=D&amp;q=http%3A%2F%2Fcreativecommons.org/licenses/by/2.5/">Creative Commons
 238 Attribution 2.5 license</a>.
 239 </p>
 240
 241 </body>
 242 </html>