Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/cassidoo/todometer
Browse files Browse the repository at this point in the history
  • Loading branch information
cassidoo committed May 16, 2017
2 parents ac9a8b9 + 488b3f1 commit f9705a4
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,37 @@
[todometer](http://cassidoo.github.io/todometer)
=========

A meter-based to-do list built with Electron, React, Redux, and LESS.
A simple meter-based to-do list built with Electron, React, Redux, and LESS.

![todometer](assets/screenshot.png)

### Contributing

So you want to contribute? Yay! Great! Fun!
I love seeing new PRs for todometer. That being said, not every pull request will be merged. The general guidelines I'll follow are:

- Does it make developing todometer easier?
- Does it help other platforms (Windows, Mac, Linux) work better?
- Does it fix a bug?
- Does it keep todometer simple?
- Does it break anything?
- Does it stick to the original goal of todometer (a _simple_, meter-based to-do list)
- Is it necessary?

Regarding that last point, I don't expect all pull requests to be absolutely necessary. New features are good. That being said, if the new features make the app unnecessarily complex in some way without bringing value to the users, it won't be merged.

Please don't be hurt if your PR isn't merged. You're lovely for working on it. If you are thinking about working on something, feel free to make an issue beforehand so that you can make sure it'll be worth your time!

### Development

* Clone the repo via `git clone https://github.com/cassidoo/todometer.git`
* Go to the project directory and install dependencies: `cd todometer && npm install`
* Start developing by `npm start`. This will show an electron window with your application's build.
- Clone the repo:
```
git clone https://github.com/cassidoo/todometer.git
```

- Go to the project directory and install dependencies:
```
cd todometer && npm install
```

- Run `npm start` to show the Electron application window with your current build.

0 comments on commit f9705a4

Please sign in to comment.