Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README
- Loading branch information
Showing
1 changed file
with
39 additions
and
1 deletion.
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 |
---|---|---|
@@ -1 +1,39 @@ | ||
#WIP | ||
# Hear Me Type | ||
|
||
**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.** | ||
|
||
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/Tynael/hear-me-type | ||
# Go into the repository | ||
cd hear-me-type | ||
# Install dependencies | ||
npm install | ||
# Run the app | ||
npm start | ||
``` | ||
|
||
Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt. | ||
|
||
## Resources for Learning Electron | ||
|
||
- [electron.atom.io/docs](http://electron.atom.io/docs) - all of Electron's documentation | ||
- [electron.atom.io/community/#boilerplates](http://electron.atom.io/community/#boilerplates) - sample starter apps created by the community | ||
- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app | ||
- [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further | ||
- [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron | ||
- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs | ||
|
||
## License | ||
|
||
[CC0 1.0 (Public Domain)](LICENSE.md) |