quine-global/hyper
1
0
Fork 0
mirror of https://github.com/quine-global/hyper.git synced 2026-01-13 04:28:41 -09:00
Code Issues Projects Releases Packages Wiki Activity Actions
hyper/README.md

46 lines
2.1 KiB
Markdown
Raw Normal View History

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)
Add AppVeyor badge
2016-11-22 03:27:45 -09:00
[![Build status](https://ci.appveyor.com/api/projects/status/txg5qb0x35h0h65p?svg=true)](https://ci.appveyor.com/project/appveyor-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
Download releases from GH until v1 So that people can stop reporting broken Linux link
2016-12-02 12:47:44 -09:00
**You can download the latest release [here](https://github.com/zeit/hyper/releases/latest)**.
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
Add Windows support and first-class Linux support (#946) * `child_pty` => `pty.js` * Create a frameless window on Windows and Linux * Add a brand new UI for Linux and Windows :nail_care: * [Windows] Fix plugin installation * [Windows] Fix the `build` script * [Windows] Add a bigger `icon.ico` * [Mac] Add `WebKitAppRegion: drag` when running on macOS * Fix code style :thinking: * Add `appveyor.yml` * Fix code style (again) * [Windows] Fix AppVeyor's `install` script * [Windows] Try a new AppVeyor config * [Windows] Set the binary path so Spectron can run the tests * [Windows] Try to build on x64 * Try again to build on x64 * Try one more time :weary: * Throw an error to indicate that `pty.js` was built incorrectly * [Win/Linux] Add `display: hidden` to <Tabs /> if tabs.length === 1 * [Win/Linux] Reorganize SVGs – via @CodeTheory * [Win/Linux] Fix the hamburger menu height * Make the SVGs look better with `shape-rendering: crispEdges;` * [Win/Linux] Add config options for the window controls and the :hamburger: menu * Add `electron-squirrel-startup` dependency * [Win] Handle Squirrel commands * [Win/Linux] Fix default color for the :hamburger: and window controls – via @CodeTheory * [Win/Linux] Add some padding - via @CodeTheory * [Win/Linux] Add hover states – via @CodeTheory * [Win] Fix empty window/tab titles * [Win] Fix opening Preferences (#978) * [Win] Fix opening Preferences * Update ui.js * Update ui.js * Enhance messages and default editor * [Win] Add dependency instructions to the README.md [skip ci] * Fix code style * [Win/Linux] Check the number of open windows before quitting the app
2016-11-11 08:18:04 -09:00
1. Install the dependencies
Add `rpm` target
2016-11-19 11:56:04 -09:00
* If you are running Linux, install `icnsutils`, `graphicsmagick`, `xz-utils` and `rpm`
Add Windows support and first-class Linux support (#946) * `child_pty` => `pty.js` * Create a frameless window on Windows and Linux * Add a brand new UI for Linux and Windows :nail_care: * [Windows] Fix plugin installation * [Windows] Fix the `build` script * [Windows] Add a bigger `icon.ico` * [Mac] Add `WebKitAppRegion: drag` when running on macOS * Fix code style :thinking: * Add `appveyor.yml` * Fix code style (again) * [Windows] Fix AppVeyor's `install` script * [Windows] Try a new AppVeyor config * [Windows] Set the binary path so Spectron can run the tests * [Windows] Try to build on x64 * Try again to build on x64 * Try one more time :weary: * Throw an error to indicate that `pty.js` was built incorrectly * [Win/Linux] Add `display: hidden` to <Tabs /> if tabs.length === 1 * [Win/Linux] Reorganize SVGs – via @CodeTheory * [Win/Linux] Fix the hamburger menu height * Make the SVGs look better with `shape-rendering: crispEdges;` * [Win/Linux] Add config options for the window controls and the :hamburger: menu * Add `electron-squirrel-startup` dependency * [Win] Handle Squirrel commands * [Win/Linux] Fix default color for the :hamburger: and window controls – via @CodeTheory * [Win/Linux] Add some padding - via @CodeTheory * [Win/Linux] Add hover states – via @CodeTheory * [Win] Fix empty window/tab titles * [Win] Fix opening Preferences (#978) * [Win] Fix opening Preferences * Update ui.js * Update ui.js * Enhance messages and default editor * [Win] Add dependency instructions to the README.md [skip ci] * Fix code style * [Win/Linux] Check the number of open windows before quitting the app
2016-11-11 08:18:04 -09:00
* 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`
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`
Remove the `start` task
2016-11-22 02:59:55 -09:00
4. Build the code and watch for changes: `npm run dev`
5. In another terminal tab/window/pane, run the app: `npm run app`
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
Make "Art" link to hyper dir in the art repo
2016-10-16 08:50:53 -08:00
- [Art](https://github.com/zeit/art/tree/master/hyper)
HyperTerm 👉 Hyper.app
2016-10-06 09:33:08 -08:00
- [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)
Reference in a new issue Copy permalink