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

Unified Diff: docs/source.md

Issue 2457813002: Update and fix some markdown docs (Closed)
Patch Set: . Created 4 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 | « docs/native_client_in_google_chrome.md ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/source.md
diff --git a/docs/source.md b/docs/source.md
index ed051541e004630ef1eaccaac22607fe96735541..d23050f04d41fa5291a34ce93c509b2e123e1b94 100644
--- a/docs/source.md
+++ b/docs/source.md
@@ -1,14 +1,11 @@
-**Quick links:** [browse source and recent revisions]
-(https://chromium.googlesource.com/native_client/src/native_client/)
-
## Browsing the source code
-If you just want to look at the source code, you can either [browse]
-(https://chromium.googlesource.com/native_client/src/native_client/) it online
-or download it with git. Here's how to download the latest version of the source
-code:
+If you just want to look at the source code, you can either
+[browse](https://chromium.googlesource.com/native_client/src/native_client/) it
+online or download it with git. Here's how to download the latest version of the
+source code:
-> `git clone https://chromium.googlesource.com/native_client/src/native_client`
+ git clone https://chromium.googlesource.com/native_client/src/native_client
If you use `git clone`, the source code appears under a directory named
`native_client` in the current directory. You can update it using `git pull`.
@@ -17,37 +14,33 @@ If you use `git clone`, the source code appears under a directory named
If you want to build the latest version of Native Client, follow these steps:
-1. If you don't already have `gclient`, get it by downloading the Chromium
- [depot tools]
- (http://dev.chromium.org/developers/how-tos/install-depot-tools).<br><br>
- <ol><li>If you don't already have <a
- href='http://git-scm.com/downloads'>git</a>, download it.<br><br>
- </li><li>Create a directory to hold the Native Client source code. We'll
- call it <code>$NACL_ROOT</code>.<br><br><b>Important:</b> Make sure the path
- to the directory has no spaces. Examples of good <code>$NACL_ROOT</code>
- values:<br><br><code>/home/me/nativeclient</code>
- <em>(Linux)</em><br><code>/Users/me/nativeclient</code>
- <em>(Mac)</em><br><code>C:\nativeclient</code> <em>(Windows)</em><br><br>
- </li><li>In a shell window, execute the following commands:<br>
- <pre><code>cd $NACL_ROOT<br>
- gclient config https://chromium.googlesource.com/native_client/src/native_client<br>
- </code></pre>
- </li><li>Download the code (this might take a few minutes):<br>
- <pre><code>cd $NACL_ROOT<br>
- gclient sync<br>
- </code></pre>
- </li></ol>
-
-Here's what the <code>gclient</code> steps do:<br> <ul><li><code>gclient
-config</code> sets up your working directory, creating a <code>.gclient</code>
-file that identifies the structure to pull from the repository.<br>
-</li><li><code>gclient sync</code> creates several subdirectories and downloads
-the latest Native Client files.</li></ul>
-
-To update the Native Client source code, run <code>gclient sync</code> from
-<code>$NACL_ROOT</code> or any of its subdirectories.<br> <br> Once you've
-downloaded the source code, you can build Native Client. To do so, you need
-Python and a platform-specific development environment. Details on prerequisites
-and how to build are in <a
-href='http://www.chromium.org/nativeclient/how-tos/build-tcb'>Building Native
-Client</a>.
+1. If you don't already have `gclient`, get it by downloading the Chromium
+ [depot tools](http://dev.chromium.org/developers/how-tos/install-depot-tools).
+2. If you don't already have [git](http://git-scm.com/downloads), download it.
+3. Create a directory to hold the Native Client source code. We'll
+ call it `$NACL_ROOT`.
+4. **Important:** Make sure the path to the directory has no spaces. Examples of
+ good `$NACL_ROOT` values:
+ - `/home/me/nativeclient` *(Linux)*
+ - `/Users/me/nativeclient` *(Mac)*
+ - `C:\nativeclient` *(Windows)*
+5. In a shell window, execute the following commands:
+
+ cd $NACL_ROOT
+ gclient config https://chromium.googlesource.com/native_client/src/native_client
+ cd $NACL_ROOT
+ gclient sync
+
+Here's what the `gclient` steps do:
+
+1. `gclient config` sets up your working directory, creating a `.gclient` file
+ that identifies the structure to pull from the repository.
+2. `gclient sync` creates several subdirectories and downloads the latest Native
+ Client files.
+
+To update the Native Client source code, run `gclient sync` from `$NACL_ROOT` or
+any of its subdirectories. Once you've downloaded the source code, you can
+build Native Client. To do so, you need Python and a platform-specific
+development environment. Details on prerequisites and how to build are in
+[Building Native
+Client](href='http://www.chromium.org/nativeclient/how-tos/build-tcb).
« no previous file with comments | « docs/native_client_in_google_chrome.md ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698