Updated readme, licenses, credits for icons

master
Steven Saus 3 years ago
parent 202e162bbf
commit 985f150796
  1. 1
      README.md
  2. 21
      weather_image/LICENSE
  3. 23
      weather_image/README.md
  4. 5
      weather_image/credit.txt

@ -79,6 +79,7 @@ Copy (and edit, as appropriate) the `weather_sh.rc` file to `$HOME\.config\weath
* The second line is your default location. (See note below)
* The third line is your default degree character (either `c` or `f`)
* The fourth line is True or False depending on whether or not you want icons displayed for the weather.
* The fifth line is whether to use `bashcolors`.
### Command-line options

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2019 Steven Saus
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.

@ -38,7 +38,10 @@ from `weather.sh` to minimize API calls if you're running both.
## 2. License
This project is licensed under the MIT license. For the full license, see `LICENSE`.
This project's *code* and *documentation* is licensed under the MIT license. For the full license, see `LICENSE`.
The *artwork* in the `icons` subdirectory is from the (free for commercial use)
[Weather Color icon set by Sihan Liu](https://www.iconfinder.com/iconsets/weather-color-2).
## 3. Prerequisites
@ -60,9 +63,24 @@ This project is licensed under the MIT license. For the full license, see `LICEN
## 4. How to use
Run `weather_images.sh` or `forecast.sh` with the appropriate commandline
Once installed, run `weather_images.sh` or `forecast.sh` with the appropriate commandline
switches (below).
### Installation
Clone the repository locally from the main directory. If you do not wish to clone the whole repository,
go to the directory you wish to clone into, and perform the following (solution from
[here](https://stackoverflow.com/questions/600079/how-do-i-clone-a-subdirectory-only-of-a-git-repository):
```
git clone --depth 1 --filter=blob:none --sparse https://github.com/uriel1998/weather.sh
cd weather.sh
git sparse-checkout set weather_image
```
Set up `weather_sh.rc`
### weather_sh.rc
If you already have a working installation of [weather.sh](https://uriel1998.github.io/weather.sh/),
@ -73,6 +91,7 @@ Copy (and edit, as appropriate) the `weather_sh.rc` file to `$HOME\.config\weath
* The second line is your default location. (See note below)
* The third line is your default degree character (either `c` or `f`)
* The fourth line is True or False depending on whether or not you want icons displayed for the weather.
* The fifth line has no effect with `weather_image.sh`, only for `weather.sh`.
### Command-line options

@ -1,5 +0,0 @@
https://www.iconfinder.com/iconsets/weather-color-2
Weather Color icon set
Avatar Sihan Liu ·
Loading…
Cancel
Save