hyper/README.md
Guillermo Rauch aaed99abac Reorg (#386)
* Step 1: move electorn into `app/`.

This is to comply with the suggested directory format of
`electron-builder`: https://github.com/electron-userland/electron-builder#two-packagejson-structure

* Step 2: add build directory with icon files for mac / windows

* Step 3: move all development (web) assets into main directory

* Step 4: add `build` namespace to dev `package.json`

* Step 5: move all dev dependencies into dev file and get rid of
old electron packagers in favor of `eletorn-builder`

* Step 6: target build inside `app/` as everything else is excluded at build time

* Step 7: remove old stuff!

* Step 8: update README

* turn off asar for `child_pty`
2016-07-24 10:59:21 -07:00

44 lines
930 B
Markdown

# hyperterm
[![Slack Channel](https://zeit-slackin.now.sh/badge.svg)](https://zeit.chat/)
![](https://cldup.com/tD67NzPryA.gif)
For downloads, documentation and the developer API head to: https://hyperterm.org
(NOTE: only on macOS) With [Homebrew](http://brew.sh/) and [Homebrew Cask](https://caskroom.github.io/) installed, you can run this command:
```bash
brew cask update
brew cask install hyperterm
```
### Repositories
- Art: https://github.com/zeit/hyperterm-art
- Website: https://github.com/zeit/hyperterm-website
- Example extension: https://github.com/zeit/hyperpower
## Contribute
To test a certain git tree, clone and then run:
```bash
npm install
npm run pack
```
then open the `./dist` folder to find the built binaries!
If you want to develop, run the above, and then you want to
run webpack in `watch` mode:
```
npm run dev
```
and to load the application simply run:
```
electron app/index.js
```