-
Notifications
You must be signed in to change notification settings - Fork 0
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
4 changed files
with
19 additions
and
71 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 |
---|---|---|
@@ -1,45 +1,30 @@ | ||
# electron-quick-start | ||
# evClient | ||
evClient is an unofficial client for the browser game [ev.io](https://ev.io). The client is not made nor is affliated with the developers of ev.io. By downloading evClient, you promise to adhere to the following rules: | ||
|
||
**Clone and run for a quick way to see Electron in action.** | ||
1. You should use the client without the intention of stealing the code or modifying the code in the client without permission from the developers. | ||
|
||
This is a minimal Electron application based on the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start) within the Electron documentation. | ||
## Client Shortcuts | ||
|
||
**Use this app along with the [Electron API Demos](https://electronjs.org/#get-started) app for API code examples to help you get started.** | ||
F1 - Opens a dialog where you can join your friends via an invite link (coming soon) | ||
|
||
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**. | ||
## Installation | ||
|
||
You can learn more about each of these components within the [Quick Start Guide](https://electronjs.org/docs/tutorial/quick-start). | ||
### For Windows: | ||
1. Install [here](https://github.com/PoweredByWard/evClient/releases/tag/1.01) | ||
2. Open PoweredClient.exe | ||
|
||
## To Use | ||
### For Other Platforms: | ||
#### Linux | ||
1. Install [here](https://github.com/PoweredByWard/evClient/releases/tag/L1.01) | ||
2. Run PoweredClient | ||
#### Mac | ||
Coming soon | ||
|
||
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: | ||
## Contact | ||
|
||
```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 | ||
``` | ||
To report issues or enquire about something, you may send me a DM (Powered#3959). | ||
|
||
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. | ||
## Credits | ||
|
||
## Resources for Learning Electron | ||
|
||
- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation | ||
- [electronjs.org/community#boilerplates](https://electronjs.org/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) | ||
Developed in collaboration by PoweredTV |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.