mirror of
https://github.com/quine-global/hyper.git
synced 2026-01-16 21:58:39 -09:00
Explain how to contribute in a more detailed way
This commit is contained in:
parent
6c82302cd3
commit
f373822f81
1 changed files with 8 additions and 18 deletions
26
README.md
26
README.md
|
|
@ -9,37 +9,27 @@
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
(NOTE: only on macOS) With [Homebrew](http://brew.sh/) and [Homebrew Cask](https://caskroom.github.io/) installed, you can run this command:
|
If you're on macOS and have [Homebrew](http://brew.sh/) + [Homebrew Cask](https://caskroom.github.io/) installed, you can download the app by running the following commands:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
brew cask update
|
brew cask update
|
||||||
brew cask install hyperterm
|
brew cask install hyperterm
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
To test a certain git tree, clone and then run:
|
1. [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
|
||||||
|
2. Install the dependencies: `npm install`
|
||||||
|
3. Build the code and watch for changes: `npm run dev`
|
||||||
|
4. In a new tab, start the application: `npm start`
|
||||||
|
|
||||||
|
If you want to build the binaries for all specified platforms, run the command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
|
||||||
npm run pack
|
npm run pack
|
||||||
```
|
```
|
||||||
|
|
||||||
then open the `./dist` folder to find the built binaries!
|
After that, you'll see the binaries in the `./dist` folder!
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
```
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
## Repositories
|
## Repositories
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue