utilities/kweather/README.md

0001 <!--
0002 - Copyright 2020 Han Young <hanyoung@protonmail.com>
0003 - Copyright 2020-2021 Devin Lin <devin@kde.org>
0004 - SPDX-License-Identifier: GPL-2.0-or-later
0005 -->
0006
0007 # KWeather <img src="org.kde.kweather.svg" width="40"/>
0008
0009 <a href='https://flathub.org/apps/details/org.kde.kweather'><img width='190px' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a>
0010
0011 A convergent weather application for Plasma.
0012
0013 ## Features
0014 * Daily and hourly weather data that can be viewed in flat and dynamic views
0015 * Plasmoid that can be used on desktop and mobile
0016
0017 ## Links
0018 * Project page: https://invent.kde.org/plasma-mobile/kweather
0019 * Issues: https://bugs.kde.org/describecomponents.cgi?product=kweather
0020 * Development channel: https://matrix.to/#/#plasmamobile:matrix.org
0021
0022 ## Dependencies
0023 * KWeatherCore (https://invent.kde.org/libraries/kweathercore)
0024 * Kirigami
0025 * Kirigami Addons
0026 * Qt Quick Controls
0027 * Qt Quick Shapes
0028
0029 ## Installing
0030 ```
0031 mkdir build
0032 cd build
0033 cmake .. # add -DCMAKE_BUILD_TYPE=Release to compile for release
0034 make
0035 sudo make install
0036 ```
0037
0038 ## Online APIs used
0039 * api.met.no - Weather data
0040 * geonames.org - Coordinates -> Timezone
0041 * geoip.ubuntu.com - IP -> Coordinates
0042
0043 ## Gallery
0044
0045 <img src="screenshots/kweather-mobile-dynamic.png" width="200px">
0046 <img src="screenshots/kweather-mobile-dynamic2.png" width="200px">
0047 <img src="screenshots/kweather-mobile-flat.png" width="200px">
0048 <img src="screenshots/kweather-desktop-dynamic.png" width="500px">