[Telemetry] Style fix, make docstrings consistent with style guide.
[chromium-blink-merge.git] / native_client_sdk / doc_generated / index.html
blobe9d95e76bb733e3016b81553e69cce37d561ee4b
1 {{+bindTo:partials.standard_nacl_article}}
3 <section id="welcome-to-native-client">
4 <h1 id="welcome-to-native-client">Welcome to Native Client</h1>
5 <div id="home">
6 <div class="pull-quote">To get the SDK and<br/>installation instructions<br/>
7 <a href="/native-client/sdk/download.html">visit the SDK Download page</a>.
8 </div>
9 <div class="big-intro"><p><strong>Native Client</strong> is a sandbox for running compiled C and C++ code in the
10 browser efficiently and securely, independent of the user&#8217;s operating system.
11 <strong>Portable Native Client</strong> extends that technology with
12 architecture independence, letting developers compile their code once to run
13 in any website and on any architecture with ahead-of-time (AOT) translation.</p>
14 <p>In short, Native Client brings the <strong>performance</strong> and <strong>low-level control</strong>
15 of native code to modern web browsers, without sacrificing the <strong>security</strong> and
16 <strong>portability</strong> of the web. Watch the video below for an overview of
17 Native Client, including its goals, how it works, and how
18 Portable Native Client lets developers run native compiled code on the web.</p>
19 <aside class="note">
20 This site uses several examples of Native Client. For the best experience,
21 consider downloading the <a class="reference external" href="https://www.google.com/chrome/">latest version of Chrome</a>. When you come back, be sure to <a class="reference external" href="https://gonativeclient.appspot.com/demo">check out
22 our demos</a>.
23 </aside>
24 </div>
26 <iframe class="video" width="600" height="337"
27 src="//www.youtube.com/embed/MvKEomoiKBA?rel=0" frameborder="0"></iframe>
28 <div class="big-intro"><h2 id="two-types-of-modules">Two Types of Modules</h2>
29 <p>Native Client comes in two flavors.</p>
30 <ul class="small-gap">
31 <li><strong>Portable Native Client (PNaCl)</strong>: Pronounced &#8216;pinnacle&#8217;, PNaCl runs single,
32 portable (<strong>pexe</strong>) executables and is available in most implementations of
33 Chrome. A translator built into Chrome translates the pexe into native code
34 for the client hardware. The entire module is translated before any code is
35 executed rather than as the code is executed. PNaCl modules can be hosted from
36 any web server.</li>
37 <li><strong>Native Client (NaCl)</strong>: Also called traditional or non-portable Native
38 Client, NaCl runs architecture-dependent (<strong>nexe</strong>) modules, which are
39 packaged into an application. At runtime, the browser decides which nexe to
40 load based on the architecture of the client machine. NaCl modules must be run
41 from the <a class="reference external" href="https://chrome.google.com/webstore/category/apps">Chrome Web Store (CWS)</a>. Fortunately, work from
42 PNaCl modules can be used to create NaCl modules.</li>
43 </ul>
44 <p>These flavors are described in more depth in <a class="reference internal" href="/native-client/nacl-and-pnacl.html"><em>PNaCl and NaCl</em></a></p>
45 <div class="left-side">
46 <div class="left-side-inner">
47 <h2>Hello World</h2>
48 <div class="big-intro"><p>To jump right in <a class="reference internal" href="/native-client/devguide/tutorial/tutorial-part1.html"><em>take the tutorial</em></a>
49 that walks you through a basic web application for Portable Native Client
50 (PNaCl). This is a client-side application that uses HTML, JavaScript, and a
51 Native Client module written in C++.</p>
52 </div>
53 </div>
54 </div>
55 <h2>A Little More Advanced</h2>
56 <div class="big-intro"><p>If you&#8217;ve already got the basics down, you&#8217;re probably trying to get a real
57 application ready for production. You&#8217;re <a class="reference internal" href="/native-client/devguide/devcycle/building.html"><em>building</em></a>, <a class="reference internal" href="/native-client/devguide/devcycle/debugging.html"><em>debugging</em></a>
58 or <a class="reference internal" href="/native-client/devguide/distributing.html"><em>ready to distribute</em></a>.</p>
59 </div>
61 <div class="left-side">
62 <div class="left-side-inner">
63 <h2>Nuts and Bolts</h2>
64 <div class="big-intro"><p>You&#8217;ve been working on a Native Client module for a while now and you&#8217;ve run
65 into an arcane problem. You may need to refer to the <a class="reference internal" href="/native-client/reference/pnacl-bitcode-abi.html"><em>PNaCl Bitcode
66 Reference</em></a> or the <a class="reference internal" href="/native-client/reference/sandbox_internals/index.html"><em>Sandbox internals</em></a>.</p>
67 </div>
68 </div>
69 </div><h2 id="i-want-to-know-everything">I Want to Know Everything</h2>
70 <p>So, you like to read now and try later. Start with our <a class="reference internal" href="/native-client/overview.html"><em>Technical Overview</em></a></p>
71 <div class="big-intro" style="clear: both;"><p>Send us comments and feedback on the <a class="reference external" href="https://groups.google.com/forum/#!forum/native-client-discuss">native-client-discuss</a> mailing list,
72 or ask questions using Stack Overflow&#8217;s <a class="reference external" href="https://stackoverflow.com/questions/tagged/google-nativeclient">google-nativeclient</a> tag.</p>
73 </div></section>
75 {{/partials.standard_nacl_article}}