|
1 | | -# Mob Timer |
2 | | - |
3 | | -[](https://github.com/mob-timer/mob-timer/releases) |
4 | | -[](https://greenkeeper.io/) |
5 | | -[](LICENSE) |
6 | | -[](https://github.com/mob-timer/mob-timer/graphs/contributors) |
7 | | -[](https://travis-ci.org/mob-timer/mob-timer/branches) |
8 | | -[](https://coveralls.io/github/mob-timer/mob-timer?branch=master) |
9 | | - |
10 | | -[](https://github.com/mob-timer/mob-timer/issues?q=is%3Aissue+is%3Aopen+label%3Aidea) |
11 | | - |
12 | | -A cross-platform mob-timer built on [Electron](http://electron.atom.io/) |
13 | | -for doing [Mob Programming](http://mobprogramming.org/). This is a fork from [pluralsight/mob-timer](https://github.com/pluralsight/mob-timer). |
14 | | - |
15 | | - |
16 | | - |
17 | | -Click the gear icon in the top right to configure the mob-timer. |
18 | | -Then click the large circle to start/stop the mob-timer, |
19 | | -or the smaller circle to skip to the next mobber. |
20 | | - |
21 | | -# Running the mob-timer |
22 | | - |
23 | | -You can either build the mob-timer from source or [download a pre-built version](https://github.com/mob-timer/mob-timer/releases). |
24 | | - |
25 | | -## Build mob-timer |
26 | | - |
27 | | -Run `npm install` and then one of the following commands for your respective operating system: |
28 | | -- Windows: `npm run build-win` |
29 | | -- Mac OS X: `npm run build-mac` |
30 | | -- Linux: `npm run build-linux` (You may need to install `libcanberra-gtk-module`) |
31 | | - |
32 | | -Platform specific packages will be placed in the `dist` directory. |
33 | | -If you need a platform other than these, you will need to modify the build script in the `package.json` file. |
34 | | - |
35 | | - |
36 | | -# Development |
37 | | - |
38 | | -Run `npm install` to get the dependencies, then `npm start` to run the timer. |
39 | | -Run `npm test` to run the unit tests once, or alternatively `npm run watch` to run them on changes. |
40 | | - |
41 | | - |
42 | | -# Contributing |
43 | | - |
44 | | -Feel free to open Issues and Pull Requests discussing additions to this project. You can also have a look at the [existing issues](https://github.com/mob-timer/mob-timer/issues). Keep the Pull Requests small and make sure the tests and code style checks pass. |
45 | | - |
46 | | -If you are uncertain, please reach out first (by opening an issue) before investing too much time. :) |
47 | | - |
48 | | -# Reasons for forking |
49 | | - |
50 | | -_This is a fork from [pluralsight/mob-timer](https://github.com/pluralsight/mob-timer), please have a look to see if that project is more suited to your needs!_ 🙂 |
51 | | - |
52 | | -There are a few main reasons for this fork existing: |
53 | | - |
54 | | -- To build in CI and attach to release using [Travis CI](https://travis-ci.org/) |
55 | | -- To stay up to date with dependencies using [Greenkeeper.io](https://greenkeeper.io/) |
56 | | -- To move to code style and tooling suited for project, not needing to take internal company best practices into account |
57 | | -- To have an independent organization where the mob-timer is the focus |
58 | | - |
59 | | -# License |
60 | | - |
61 | | -The Mob Timer is licensed under the [Apache 2.0 license](LICENSE). |
| 1 | +# Mob Timer |
| 2 | + |
| 3 | +[](https://github.com/mob-timer/mob-timer/releases) |
| 4 | +[](https://greenkeeper.io/) |
| 5 | +[](LICENSE) |
| 6 | +[](https://github.com/mob-timer/mob-timer/graphs/contributors) |
| 7 | +[](https://travis-ci.org/mob-timer/mob-timer/branches) |
| 8 | +[](https://coveralls.io/github/mob-timer/mob-timer?branch=master) |
| 9 | + |
| 10 | +[](https://github.com/mob-timer/mob-timer/issues?q=is%3Aissue+is%3Aopen+label%3Aidea) |
| 11 | + |
| 12 | +A cross-platform mob-timer built on [Electron](http://electron.atom.io/) |
| 13 | +for doing [Mob Programming](http://mobprogramming.org/). This is a fork from [pluralsight/mob-timer](https://github.com/pluralsight/mob-timer). |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +Click the gear icon in the top right to configure the mob-timer. |
| 18 | +Then click the large circle to start/stop the mob-timer, |
| 19 | +or the smaller circle to skip to the next mobber. |
| 20 | + |
| 21 | +# Running the mob-timer |
| 22 | + |
| 23 | +You can either build the mob-timer from source or [download a pre-built version](https://github.com/mob-timer/mob-timer/releases). |
| 24 | + |
| 25 | +## Build mob-timer |
| 26 | + |
| 27 | +Run `npm install` and then one of the following commands for your respective operating system: |
| 28 | +- Windows: `npm run build-win` |
| 29 | +- Mac OS X: `npm run build-mac` |
| 30 | +- Linux: `npm run build-linux` (You may need to install `libcanberra-gtk-module`) |
| 31 | + |
| 32 | +Platform specific packages will be placed in the `dist` directory. |
| 33 | +If you need a platform other than these, you will need to modify the build script in the `package.json` file. |
| 34 | + |
| 35 | + |
| 36 | +# Development |
| 37 | + |
| 38 | +Run `npm install` to get the dependencies, then `npm start` to run the timer. |
| 39 | +Run `npm test` to run the unit tests once, or alternatively `npm run watch` to run them on changes. |
| 40 | + |
| 41 | + |
| 42 | +# Contributing |
| 43 | + |
| 44 | +Feel free to open Issues and Pull Requests discussing additions to this project. You can also have a look at the [existing issues](https://github.com/mob-timer/mob-timer/issues). Keep the Pull Requests small and make sure the tests and code style checks pass. |
| 45 | + |
| 46 | +If you are uncertain, please reach out first (by opening an issue) before investing too much time. :) |
| 47 | + |
| 48 | +# Reasons for forking |
| 49 | + |
| 50 | +_This is a fork from [pluralsight/mob-timer](https://github.com/pluralsight/mob-timer), please have a look to see if that project is more suited to your needs!_ 🙂 |
| 51 | + |
| 52 | +There are a few main reasons for this fork existing: |
| 53 | + |
| 54 | +- To build in CI and attach to release using [Travis CI](https://travis-ci.org/) |
| 55 | +- To stay up to date with dependencies using [Greenkeeper.io](https://greenkeeper.io/) |
| 56 | +- To move to code style and tooling suited for project, not needing to take internal company best practices into account |
| 57 | +- To have an independent organization where the mob-timer is the focus |
| 58 | + |
| 59 | +# License |
| 60 | + |
| 61 | +The Mob Timer is licensed under the [Apache 2.0 license](LICENSE). |
0 commit comments