Skip to content

Commit

Permalink
Add maintaining.md (wulkano#291)
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus authored Nov 7, 2017
1 parent f2ca388 commit ab704d2
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 15 deletions.
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,15 @@

**[Download the latest release](https://getkap.co/download)** (macOS only)

Or install with [Homebrew Cask](https://caskroom.github.io):
Or install with [Homebrew-Cask](https://caskroom.github.io):

```
$ brew update
$ brew cask install kap
$ brew update && brew cask install kap
```

## Contribute

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. Run the app: `npm start`

To make sure that your code works in the finished app, you can generate the binary:

```
$ npm run pack
```

After that, you'll see the binary in the `./dist` folder :smile:
Read the [contribution guide](contributing.md).

## Dev builds

Expand Down
14 changes: 14 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contributing

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 another terminal tab, run the app: `npm start`

To make sure that your code works in the finished app, you can generate the binary:

```
$ npm run pack
```

After that, you'll see the binary in the `dist` folder 😀
7 changes: 7 additions & 0 deletions maintaining.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Maintaining

## Developing Kap

Run `npm run dev` in one terminal tab to start watch mode, and in another tab, run `npm start` to launch Kap.

We strongly recommend installing an [XO editor plugin](https://github.com/sindresorhus/xo#editor-plugins) for JavaScript linting and a [Stylelint editor plugin](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/complementary-tools.md#editor-plugins) for CSS linting. Both of these support auto-fix on save.

0 comments on commit ab704d2

Please sign in to comment.