-
Notifications
You must be signed in to change notification settings - Fork 269
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/cassidoo/todometer
- Loading branch information
Showing
1 changed file
with
29 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |