You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

30 lines
1.2 KiB

10 years ago
10 years ago
10 years ago
  1. # electron-quick-start
  2. **Clone and run for a quick way to see an Electron in action.**
  3. 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.
  4. A basic Electron application needs just these files:
  5. - `index.html` - A web page to render.
  6. - `main.js` - Starts the app and creates a browser window to render HTML.
  7. - `package.json` - Points to the app's main file and lists its details and dependencies.
  8. You can learn more about each of these components within the [Quick Start Guide](http://electron.atom.io/docs/latest/tutorial/quick-start).
  9. ## To Use
  10. 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:
  11. ```bash
  12. # Clone this repository
  13. $ git clone https://github.com/atom/electron-quick-start
  14. # Go into the repository
  15. $ cd electron-quick-start
  16. # Install dependencies and run the app
  17. $ npm install && npm start
  18. ```
  19. Learn more about Electron and its API in the [documentation](http://electron.atom.io/docs/latest).
  20. #### License [MIT](LICENSE.md)