hyper/README.md

![](https://github.com/zeit/art/blob/525bd1bb39d97dd3b91c976106a6d5cc5766b678/hyper/repo-banner.png)

[![Build Status](https://travis-ci.org/zeit/hyper.svg?branch=master)](https://travis-ci.org/zeit/hyper)
[![Slack Channel](https://zeit-slackin.now.sh/badge.svg)](https://zeit.chat/)
[![Changelog #213](https://img.shields.io/badge/changelog-%23213-lightgrey.svg)](https://changelog.com/213)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

For more details, head to: https://hyper.is

## Usage

You can download the latest release [here](https://hyper.is/#installation).

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. If you are running Linux, install "icnsutils", "graphicsmagick" and "xz-utils"
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, watch for changes and run the app: `npm start`

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)
- [Website](https://github.com/zeit/hyper-website)
- [Sample Extension](https://github.com/zeit/hyperpower)
- [Sample Theme](https://github.com/zeit/hyperyellow)
Update repo banner (#794) * Update repo banner * Update link to new banner 2016-10-06 11:30:17 -08:00			`![](https://github.com/zeit/art/blob/525bd1bb39d97dd3b91c976106a6d5cc5766b678/hyper/repo-banner.png)`
Put logo on top 2016-07-27 05:31:13 -08:00
Update Travis CI badge URL (#793) * Update Travis CI badge URL * HyperTerm 👉 Hyper.app 2016-10-06 11:09:44 -08:00			`[![Build Status](https://travis-ci.org/zeit/hyper.svg?branch=master)](https://travis-ci.org/zeit/hyper)`
Build badge is more important 2016-07-27 07:08:51 -08:00			`[![Slack Channel](https://zeit-slackin.now.sh/badge.svg)](https://zeit.chat/)`
Add Changelog episode badge to README (#543) Links to: https://changelog.com/213 2016-08-02 11:08:41 -08:00			`[![Changelog #213](https://img.shields.io/badge/changelog-%23213-lightgrey.svg)](https://changelog.com/213)`
Mention code style 2016-09-21 06:36:31 -08:00			`[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)`
Update README.md 2016-07-21 10:49:29 -08:00
New URL 2016-10-06 08:39:14 -08:00			`For more details, head to: https://hyper.is`
Update README.md 2016-07-15 08:22:55 -08:00
Clean up 2016-07-27 05:41:49 -08:00			`## Usage`
Update README.md 2016-07-15 08:22:55 -08:00
HyperTerm 👉 Hyper.app 2016-10-06 09:33:08 -08:00			`You can download the latest release [here](https://hyper.is/#installation).`
Much more explicit 2016-07-27 07:12:16 -08:00
			`If you're on macOS, you can also use [Homebrew Cask](https://caskroom.github.io/) to download the app by running these commands:`
add homebrew cask install method (#273) 2016-07-19 09:44:44 -08:00
			```bash
README: brew cask update to brew update (#866) 2016-10-12 05:25:36 -08:00			`$ brew update`
Change cask install to hyper (#809) It looks like the cask package name has changed in the renaming ``` brew cask install hyperterm Error: No available Cask for hyperterm Error: nothing to install ``` 2016-10-07 03:09:35 -08:00			`$ brew cask install hyper`
add homebrew cask install method (#273) 2016-07-19 09:44:44 -08:00			```

Minor improvements (#15) * Use caps * Comments for ignored stuff * Description added * Use start command for launch * Cosmetic changes 2016-07-02 11:03:45 -08:00			`## Contribute`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00
Shorter explanation 2016-09-10 15:26:32 -08:00			`1. If you are running Linux, install "icnsutils", "graphicsmagick" and "xz-utils"`
doc: add platform specific build dependencies for electron (#660) These are all taken from: https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build 2016-08-29 14:32:06 -08:00			`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`
Use start script for development 2016-09-21 21:59:24 -08:00			4. Build the code, watch for changes and run the app: `npm start`
Explain how to contribute in a more detailed way 2016-07-27 05:50:04 -08:00
Fixed gramatical errors should be using `this` as pointing to the next command not the previous command. 2016-10-09 09:25:34 -08:00			`To make sure that your code works in the finished application, you can generate the binaries like this:`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00
			```bash
Indicate command line 2016-07-29 00:08:10 -08:00			`$ npm run pack`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00			```

Remove wrong info about builds (#682) 2016-09-05 03:57:30 -08:00			After that, you'll see the binary in the `./dist` folder!
doc: add platform specific build dependencies for electron (#660) These are all taken from: https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build 2016-08-29 14:32:06 -08:00
Use links for related repos 2016-07-27 07:03:50 -08:00			`## Related Repositories`
Clean up 2016-07-27 05:41:49 -08:00
HyperTerm 👉 Hyper.app 2016-10-06 09:33:08 -08:00			`- [Art](https://github.com/zeit/art)`
			`- [Website](https://github.com/zeit/hyper-website)`
Use links for related repos 2016-07-27 07:03:50 -08:00			`- [Sample Extension](https://github.com/zeit/hyperpower)`
Unneeded space 2016-08-08 07:28:08 -08:00			`- [Sample Theme](https://github.com/zeit/hyperyellow)`