This repository has been archived by the owner on Feb 17, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
244 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,6 @@ | ||
# electron-quick-start | ||
# xkcd-simplewriter | ||
|
||
**Clone and run for a quick way to see an Electron in action.** | ||
![](https://blogdotxkcddotcom.files.wordpress.com/2015/09/blag_words2.png) | ||
|
||
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. | ||
A desktop app version of the [XKCD simplewriter](http://xkcd.com/simplewriter/) | ||
|
||
A 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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.