Browse Source

Add links to electron-quick-start

Jessica Lord 9 years ago
parent
commit
bc7c7da799
2 changed files with 21 additions and 0 deletions
  1. 5 0
      README.md
  2. 16 0
      docs/tutorial/quick-start.md

+ 5 - 0
README.md

@@ -53,6 +53,11 @@ contains documents describing how to build and contribute to Electron.
 - [Simplified Chinese](https://github.com/atom/electron/tree/master/docs-translations/zh-CN)
 - [Traditional Chinese](https://github.com/atom/electron/tree/master/docs-translations/zh-TW)
 
+## Quick Start
+
+Clone and run the [`atom/electron-quick-start`](https://github.com/atom/electron-quick-start)
+repository to see a minimal Electron app in action.
+
 ## Community
 
 You can ask questions and interact with the community in the following

+ 16 - 0
docs/tutorial/quick-start.md

@@ -188,3 +188,19 @@ it from [here](https://github.com/atom/electron/releases).
 After you're done writing your app, you can create a distribution by
 following the [Application Distribution](./application-distribution.md) guide
 and then executing the packaged app.
+
+### Try this Example
+
+Clone and run the code in this tutorial by using the [`atom/electron-quick-start`](https://github.com/atom/electron-quick-start)
+repository.
+
+**Note**: Running this requires [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which includes [npm](https://npmjs.org)) on your system.
+
+```bash
+# Clone the repository
+$ git clone https://github.com/atom/electron-quick-start
+# Go into the repository
+$ cd electron-quick-start
+# Install dependencies and run the app
+$ npm install && npm start
+```