native_client/README.md

   1 #  Native Client
   2
   3 Welcome to Native Client.  For the latest information about Native Client, see
   4 the [Native Client project page](http://code.google.com/p/nativeclient).
   5
   6 ##  Documentation
   7
   8 Most of the Native Client project documentation is available online:
   9
  10  * Documentation for [Native Client users](http://gonacl.com)
  11  * Documentation for [contributors to Native
  12    Client](http://www.chromium.org/nativeclient)
  13  * [Research
  14    papers](http://www.chromium.org/nativeclient/reference/research-papers)
  15
  16 ##  Directory structure
  17
  18 The following list describes major files and directories that you'll see in
  19 your working copy of the repository, including some directories that don't
  20 exist until you've built Native Client. Paths are relative to the
  21 `native_client` directory.
  22
  23  * `COPYING NOTICE README.md RELEASE_NOTES documentation/`: Documentation,
  24    release, and license information.
  25
  26  * `SConstruct scons.bat scons scons-out/ site_scons/`: Build-related files.
  27    The `scons.bat` and `scons` files, with data from `SConstruct`, let you
  28    build Native Client and its tests. The `scons-out` and `site-scons`
  29    directories don't exist in the git repository; they're created when Native
  30    Client is built. The `scons-out/*/staging` directories contain files, such
  31    as the Native Client plug-in and compiled examples, that let you use and
  32    test Native Client.
  33
  34  * `src/`: Core source code for Native Client.
  35
  36  * `src/include/`: Header files that are missing from some platforms and are
  37    used by more than one major part of Native Client
  38
  39  * `src/shared/`: Source code that's used by both trusted code (such as the
  40    service runtime) and untrusted code (such as Native Client modules)
  41
  42  * `src/third_party`: Other people's source code
  43
  44  * `src/trusted/`: Source code that's used only by trusted code
  45
  46  * `src/untrusted/`: Source code that's used only by untrusted code
  47
  48  * `tests/common/`: Source code for examples and tests.
  49
  50  * `../third_party/`: Third-party source code and binaries that aren't part of
  51    the service runtime.  When built, the Native Client toolchain is in
  52    `src/third_party/nacl_sdk/`.
  53
  54  * `tools/`: Utilities such as the plug-in installer.