hyper/README.md

42 lines
1.6 KiB
Markdown
Raw Normal View History

2016-09-12 07:13:25 -08:00
![](https://github.com/zeit/art/blob/master/branding/HyperTerm-banner.png)
2016-07-27 05:31:13 -08:00
2016-07-27 04:40:19 -08:00
[![Build Status](https://travis-ci.org/zeit/hyperterm.svg?branch=master)](https://travis-ci.org/zeit/hyperterm)
2016-07-27 07:08:51 -08:00
[![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)
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)
2016-07-21 10:49:29 -08:00
2016-07-27 07:02:21 -08:00
For more details, head to: https://hyperterm.org
2016-07-15 08:22:55 -08:00
2016-07-27 05:41:49 -08:00
## Usage
2016-07-15 08:22:55 -08:00
2016-08-08 07:28:40 -08:00
You can download the latest release [here](https://hyperterm.org/#installation).
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:
```bash
2016-07-29 00:08:10 -08:00
$ brew cask update
$ brew cask install hyperterm
```
## Contribute
2016-09-10 15:26:32 -08:00
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`
2016-09-21 21:59:24 -08:00
4. Build the code, watch for changes and run the app: `npm start`
2016-09-16 08:52:50 -08:00
To make sure that your code works in the finished application, you can generate the binaries like that:
```bash
2016-07-29 00:08:10 -08:00
$ npm run pack
```
2016-09-05 03:57:30 -08:00
After that, you'll see the binary in the `./dist` folder!
2016-07-27 07:03:50 -08:00
## Related Repositories
2016-07-27 05:41:49 -08:00
2016-07-27 07:03:50 -08:00
- [Art](https://github.com/zeit/hyperterm-art)
- [Website](https://github.com/zeit/hyperterm-website)
- [Sample Extension](https://github.com/zeit/hyperpower)
2016-08-08 07:28:08 -08:00
- [Sample Theme](https://github.com/zeit/hyperyellow)