first-electron/README.md

# electron-quick-start

**Clone and run for a quick way to see Electron in action.**

This is a minimal Electron application based on the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start) within the Electron documentation.

**Use this app along with the [Electron API Demos](http://electron.atom.io/#get-started) app for API code examples to help you get started.**

A basic Electron application needs just these files:

- `package.json` - Points to the app's main file and lists its details and dependencies.
- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.
- `index.html` - A web page to render. This is the app's **renderer process**.

You can learn more about each of these components within the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start).

## To Use

To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:

```bash
# Clone this repository
git clone https://github.com/electron/electron-quick-start
# Go into the repository
cd electron-quick-start
# Install dependencies
npm install
# Run the app
npm start
```

Learn more about Electron and its API in the [documentation](http://electron.atom.io/docs/).

---
Warning: Windows 10 users might encounter some errors while running `npm start` from Linux Bash for Windows. The reason for this is that Electron is a GUI application, but Linux bash for Windows is just a headless VM without any GUI ( [explained here](https://github.com/electron/electron-quick-start/issues/129#issuecomment-279701745) ).
A temporary workaround is getting [NodeJS for Windows](https://nodejs.org/en/) and use the node cmd.

## Other Example Apps

For more example apps, see the
[list of boilerplates](http://electron.atom.io/community/#boilerplates)
created by the awesome electron community.

#### License [CC0 1.0 (Public Domain)](LICENSE.md)
Initial commit 2015-10-17 07:56:39 +08:00			`# electron-quick-start`
Add readme 2015-10-17 08:52:00 +08:00
Remove "an" from intro The wording is awkward. I think removing "an" works. Alternatively, adding the word "application" after "Electron" works too. 2016-11-23 05:47:50 +08:00			`Clone and run for a quick way to see Electron in action.`
Add readme 2015-10-17 08:52:00 +08:00
Fix Readme Quick Start Guide links Fix Readme Quick Start Guide links 2016-12-24 03:21:36 +08:00			`This is a minimal Electron application based on the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start) within the Electron documentation.`
Add readme 2015-10-17 08:52:00 +08:00
Mention the Electron API Demos app 2016-05-11 14:48:52 +08:00			`Use this app along with the [Electron API Demos](http://electron.atom.io/#get-started) app for API code examples to help you get started.`

Fix typo in description ("an" :arrow_right: "a") 2015-10-21 15:55:42 +08:00			`A basic Electron application needs just these files:`
Add readme 2015-10-17 08:52:00 +08:00
			- `package.json` - Points to the app's main file and lists its details and dependencies.
A few tweaks to readme 2016-04-21 06:18:14 +08:00			- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's main process.
			- `index.html` - A web page to render. This is the app's renderer process.
Add readme 2015-10-17 08:52:00 +08:00
Fix Readme Quick Start Guide links Fix Readme Quick Start Guide links 2016-12-24 03:21:36 +08:00			`You can learn more about each of these components within the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start).`
Add readme 2015-10-17 08:52:00 +08:00
			`## To Use`

			`To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:`

			```bash
			`# Clone this repository`
Update urls for new GitHub org 2016-04-05 04:00:14 +08:00			`git clone https://github.com/electron/electron-quick-start`
Add readme 2015-10-17 08:52:00 +08:00			`# Go into the repository`
Remove $ in code example Let's make this copy/paste able. 2016-01-01 23:15:54 +08:00			`cd electron-quick-start`
Separate install and start steps 2016-11-01 01:38:04 +08:00			`# Install dependencies`
			`npm install`
			`# Run the app`
			`npm start`
Add readme 2015-10-17 08:52:00 +08:00			```

Fix links that 404 or redirect http://electron.atom.io/docs/tutorial/quick-start/ -> Replaces links that were 404ing http://electron.atom.io/docs/ -> Replaces a link that was redirecting via 301 2016-12-21 23:19:32 +08:00			`Learn more about Electron and its API in the [documentation](http://electron.atom.io/docs/).`
Add readme 2015-10-17 08:52:00 +08:00
Warning for Win10 on readme Added a warning for Windows 10 users facing npm errors. Most of the times that's the problem 2017-02-16 17:32:58 +08:00			`---`
			Warning: Windows 10 users might encounter some errors while running `npm start` from Linux Bash for Windows. The reason for this is that Electron is a GUI application, but Linux bash for Windows is just a headless VM without any GUI ( [explained here](https://github.com/electron/electron-quick-start/issues/129#issuecomment-279701745) ).
			`A temporary workaround is getting [NodeJS for Windows](https://nodejs.org/en/) and use the node cmd.`

link to boilerplates 2016-07-15 06:02:18 +08:00			`## Other Example Apps`

			`For more example apps, see the`
			`[list of boilerplates](http://electron.atom.io/community/#boilerplates)`
			`created by the awesome electron community.`

update license text in README 2016-10-05 00:37:02 +08:00			`#### License [CC0 1.0 (Public Domain)](LICENSE.md)`