hyper/README.md

# 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
```
update readme 2016-07-01 11:00:09 -08:00			`# hyperterm`
improve readme 2016-06-30 22:21:29 -08:00
Added link to slack badge (#361) * Added link to slack badge * Changed url to https://zeit.chat/ 2016-07-22 08:24:25 -08:00			`[![Slack Channel](https://zeit-slackin.now.sh/badge.svg)](https://zeit.chat/)`
Update README.md 2016-07-21 10:49:29 -08:00
Update README.md 2016-07-15 08:22:55 -08:00			`![](https://cldup.com/tD67NzPryA.gif)`

			`For downloads, documentation and the developer API head to: https://hyperterm.org`

add homebrew cask install method (#273) 2016-07-19 09:44:44 -08:00			`(NOTE: only on macOS) With [Homebrew](http://brew.sh/) and [Homebrew Cask](https://caskroom.github.io/) installed, you can run this command:`

			```bash
Remove $ from README.md (#358) as discussed in: https://github.com/zeit/hyperterm/pull/356 2016-07-21 19:26:32 -08:00			`brew cask update`
			`brew cask install hyperterm`
add homebrew cask install method (#273) 2016-07-19 09:44:44 -08:00			```

Update README.md 2016-07-15 12:18:15 -08:00			`### Repositories`

			`- Art: https://github.com/zeit/hyperterm-art`
			`- Website: https://github.com/zeit/hyperterm-website`
			`- Example extension: https://github.com/zeit/hyperpower`

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
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 09:59:21 -08:00			`To test a certain git tree, clone and then run:`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00
			```bash
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 09:59:21 -08:00			`npm install`
			`npm run pack`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00			```

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 09:59:21 -08:00			then open the `./dist` folder to find the built binaries!
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00
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 09:59:21 -08:00			`If you want to develop, run the above, and then you want to`
			run webpack in `watch` mode:

			```
Remove $ from terminal commands in README (#130) * Remove $ from terminal commands in README So they can be copied and pasted a block at a time * Remove dependency on globally installed webpack 2016-07-21 11:07:35 -08:00			`npm run dev`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00			```

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 09:59:21 -08:00			`and to load the application simply run:`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00
			```
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 09:59:21 -08:00			`electron app/index.js`
			```