Add a free license, write readme, change app and project name, update info in package.json.master
parent
367ec26e79
commit
49d649a3b3
12 changed files with 74 additions and 27 deletions
@ -0,0 +1,21 @@ |
||||
The MIT License (MIT) |
||||
|
||||
Copyright (c) 2017 Tanner Collin |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
SOFTWARE. |
@ -1,14 +1,37 @@ |
||||
## Counter Example |
||||
# Exact Resistor Calculator |
||||
Recommends resistors to combine in parallel to meet an exact target. |
||||
|
||||
#### React-Native 0.32.0 & Redux 3.5.2 & React-Redux 4.4.5 |
||||
## Usage |
||||
|
||||
This repo demonstrates the usage of latest React-Native with Redux. |
||||
Enter the target resistance you wish to make in the first field. |
||||
The app will then recommend a value for a resistor to start with. |
||||
It will be the same value as you entered because that will obviously get you to your target. |
||||
|
||||
### Usage |
||||
Next go find a resistor as close to the recommended value and then measure it. |
||||
Enter the reading into the list of resistors that you have. |
||||
Then keep doing this for all the resistor values that the app recommends. |
||||
|
||||
- you have to use `npm@3.x`, if you are using `npm@2.x` you might get into some weird scenarios. Please open an issue if you can't get it run on `npm@2.x`. also you can follow this [issue](https://github.com/rackt/react-redux/issues/236) for more info. |
||||
- clone the project |
||||
- go to `Counter` folder |
||||
- run `npm install` |
||||
Within 2-3 resistors, you'll notice the percent error from your target will drop well into a suitable range. |
||||
|
||||
Cheers, |
||||
## Setup |
||||
|
||||
Please install Exact Resistor Calculator from the Google Play Store on your Android phone for free. |
||||
|
||||
## Source Code |
||||
|
||||
### License |
||||
|
||||
Exact Resistor Calculator is free and open-source software released under the MIT License. |
||||
|
||||
### Building |
||||
|
||||
Building Exact Resistor Calculator from source is very easy. |
||||
Clone this repository, set up react-native, and then run these commands: |
||||
|
||||
``` |
||||
$ npm install |
||||
$ react-native run-android |
||||
$ react-native start |
||||
``` |
||||
|
||||
If you want to debug on your physical phone, be sure to run ```adb reverse tcp:8081 tcp:8081``` first. |
||||
|
@ -1,3 +1,3 @@ |
||||
<resources> |
||||
<string name="app_name">Counter</string> |
||||
<string name="app_name">Exact Resistor Calculator</string> |
||||
</resources> |
||||
|
Loading…
Reference in new issue