Browse Source

Add readme

main
Jessica Lord 10 years ago
parent
commit
501541fd8b
  1. 30
      README.md

30
README.md

@ -1,2 +1,30 @@
# electron-quick-start # electron-quick-start
Fork and clone to try a simple Electron app
**Clone and run for a quick way to see an Electron in action.**
This is a minimal Electron application based on the [Quick Start Guide](http://electron.atom.io/docs/latest/tutorial/quick-start) within the Electron documentation.
An basic Electron application needs just these files:
- `index.html` - A web page to render.
- `main.js` - Starts the app and creates a browser window to render HTML.
- `package.json` - Points to the app's main file and lists its details and dependencies.
You can learn more about each of these components within the [Quick Start Guide](http://electron.atom.io/docs/latest/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/atom/electron-quick-start
# Go into the repository
$ cd electron-quick-start
# Install dependencies and run the app
$ npm install && npm start
```
Learn more about Electron and its API in the [documentation](http://electron.atom.io/docs/latest).
#### License [MIT](LICENSE.md)
Loading…
Cancel
Save