Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(141)

Unified Diff: native_client_sdk/src/doc/sdk/index.rst

Issue 26458006: [NaClDocs] Fill in the landing page for the SDK section of the docs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: tweak Created 7 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: native_client_sdk/src/doc/sdk/index.rst
diff --git a/native_client_sdk/src/doc/sdk/index.rst b/native_client_sdk/src/doc/sdk/index.rst
index 077f63faab7f671157a487cd0596deb83a8846fb..c9fb434f0c1b212b6634a711c2fb921051013d20 100644
--- a/native_client_sdk/src/doc/sdk/index.rst
+++ b/native_client_sdk/src/doc/sdk/index.rst
@@ -4,5 +4,54 @@
Native Client SDK
#################
-This is the index of the ``sdk`` directory.
+To build Native Client modules, you must download and install the Native
+Client Software Development Kit (SDK).
+
+The SDK includes the following:
+
+support for multiple Pepper versions
+ The SDK contains **bundles** that let you compile Native Client modules
+ using different versions of the
+ `Pepper API </overview.html#link_pepper>`_
+ (e.g., Pepper 28 or Pepper 29). Review the
eliben 2013/10/16 22:05:21 maybe bump to pepper_30 and pepper_canary? The la
jvoung (off chromium) 2013/10/16 23:56:13 Done.
+ :doc:`Release Notes <release-notes>` for a description of the new features
+ included in each Pepper version to help you decide which bundle to
+ use to develop your application. In general, Native Client modules
+ compiled using a particular Pepper version will work in
+ corresponding versions of Chrome and higher. For example, a module
+ compiled using the Pepper 28 platform will work in Chrome 28 and
+ higher.
+
+update utility
+ The ``naclsdk`` utility (``naclsdk.bat`` on Windows) lets you download new
+ bundles that are available, as well as new versions of existing bundles.
+
+toolchains
+ Each platform includes three toolchains---one for Portable Native Client
+ (PNaCl) applications, one for compiling architecture-specific Native
+ Client applications with newlib, and a third native NaCl toolchain for
+ compiling with glibc. Newlib and glibc are two different implementations
+ of the C standard library. All toolchains contain Native Client-compatible
+ versions of standard compilers, linkers, and other tools.
+ See :doc:`this document </nacl-and-pnacl>` to help you choose the
+ right toolchain.
+
+examples
+ Each example in the SDK includes C or C++ source files and header files
+ illustrating how to use NaCl and Pepper, along with a Makefile to build
+ the example using each of the toolchains.
+
+Makefiles
eliben 2013/10/16 22:05:21 How about nuking this one? It goes too deep into t
jvoung (off chromium) 2013/10/16 23:56:13 Yeah, it's part of examples.
+ Makefiles have been kept simple so that they are easy to understand,
+ use, and modify. Glance through or run the Makefiles with ``V=1``
+ to determine the commands that are needed to build an application,
+ then plug those commands into your own build system if you prefer.
+
+tools
+ The SDK includes a number of additional tools, which you can use for
+ tasks such as validating Native Client modules and running modules
+ from the command line.
+
+To download and install the SDK, follow the instructions on the
+:ref:`Download <download>` page.
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698