From b9d2781cb571b50ddd992313a9720ce628c3a74c Mon Sep 17 00:00:00 2001 From: mijdavis2 Date: Mon, 10 Jul 2017 21:26:09 -0700 Subject: [PATCH] Update readme and add license Add license Update readme --- LICENSE | 21 ++++++++++ README.md | 39 ++++++++++--------- src/renderer/components/LandingPage.vue | 3 +- .../Report/StreamflowCalculator.vue | 1 + 4 files changed, 44 insertions(+), 20 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bcf48f9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 MJ Davis + +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. \ No newline at end of file diff --git a/README.md b/README.md index 293939f..d23de7a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ -# upstream +# UpStream + +

+ UpStream is a stream flow calc utility designed for Trout Unlimited. +

+ + +> **CURRENTLY IN BETA** +> +>Missing features: +> - saving reports +> - loading reports +> - exporting reports as csv files +> - loading config files -> Streamflow calc utility for Trout Unlimited ## Requirements @@ -28,26 +40,15 @@ yarn run lint ## Build -`electron-packager ./ upstream --all --overwrite` - -## Specs +`yarn run build` -_Just some notes on desired features_ - -Inputs -- startBank.tapeFt: int -- endBank.tapeFt: int +This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html). -Output -- numberOfStationOptions - - "If 14 stations, take measurements every x ft" - - "" same for 15-17+ +## License -^ Click one of those options +**Software:** [MIT (c) 2017](LICENSE) -Output -- table with tapeFt set for each station ---- +**Icons:** -This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html). +-

Scroll icon made by Daniel Bruce from www.flaticon.com is licensed by CC 3.0 BY

diff --git a/src/renderer/components/LandingPage.vue b/src/renderer/components/LandingPage.vue index 066b323..34dd691 100644 --- a/src/renderer/components/LandingPage.vue +++ b/src/renderer/components/LandingPage.vue @@ -61,7 +61,8 @@
-
Icons made by Freepik from www.flaticon.com is licensed by CC 3.0 BY
+
Icons made by Daniel Bruce from www.flaticon.com is licensed by CC 3.0 BY
+
Icons made by Baianat from www.flaticon.com is licensed by CC 3.0 BY
diff --git a/src/renderer/components/Report/StreamflowCalculator.vue b/src/renderer/components/Report/StreamflowCalculator.vue index c6d4ba4..9d0d448 100644 --- a/src/renderer/components/Report/StreamflowCalculator.vue +++ b/src/renderer/components/Report/StreamflowCalculator.vue @@ -90,6 +90,7 @@ totalDischarge: '' }), created () { + // TODO: remove mock data fallback this.items = this.$store.getters.flowData.length > 0 ? this.$store.getters.flowData : mockData }, computed: {