mirror of
https://github.com/quine-global/hyper.git
synced 2026-01-13 12:38:39 -09:00
45 lines
2.1 KiB
Markdown
45 lines
2.1 KiB
Markdown
|
|
|
|
[](https://travis-ci.org/zeit/hyper)
|
|
[](https://ci.appveyor.com/project/appveyor-zeit/hyper)
|
|
[](https://zeit.chat/)
|
|
[](https://changelog.com/213)
|
|
[](https://github.com/sindresorhus/xo)
|
|
|
|
For more details, head to: https://hyper.is
|
|
|
|
## Usage
|
|
|
|
**You can download the latest release [here](https://github.com/zeit/hyper/releases/latest)**.
|
|
|
|
If you're on macOS, you can also use [Homebrew Cask](https://caskroom.github.io/) to download the app by running these commands:
|
|
|
|
```bash
|
|
$ brew update
|
|
$ brew cask install hyper
|
|
```
|
|
|
|
## Contribute
|
|
|
|
1. Install the dependencies
|
|
* If you are running Linux, install `icnsutils`, `graphicsmagick`, `xz-utils` and `rpm`
|
|
* If you are running Windows, install [VC++ Build Tools Technical Preview](http://go.microsoft.com/fwlink/?LinkId=691126) using the **Default Install option**; Install Python 2.7 and add it to your `%PATH%`; Run `npm config set msvs_version 2015 --global`
|
|
2. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
|
|
3. Install the dependencies: `npm install`
|
|
4. Build the code and watch for changes: `npm run dev`
|
|
5. In another terminal tab/window/pane, run the app: `npm run app`
|
|
|
|
To make sure that your code works in the finished application, you can generate the binaries like this:
|
|
|
|
```bash
|
|
$ npm run pack
|
|
```
|
|
|
|
After that, you'll see the binary in the `./dist` folder!
|
|
|
|
## Related Repositories
|
|
|
|
- [Art](https://github.com/zeit/art/tree/master/hyper)
|
|
- [Website](https://github.com/zeit/hyper-website)
|
|
- [Sample Extension](https://github.com/zeit/hyperpower)
|
|
- [Sample Theme](https://github.com/zeit/hyperyellow)
|