From 66451c6eeb4cf3eeb69d0798be60cbf13873c6a6 Mon Sep 17 00:00:00 2001 From: simon04 Date: Fri, 3 Jun 2011 22:28:35 +0200 Subject: [PATCH] Updated README. --- README | 61 ------------------------------------------------------- README.md | 39 +++++++++++++++++------------------ 2 files changed, 19 insertions(+), 81 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index 2c0702b..0000000 --- a/README +++ /dev/null @@ -1,61 +0,0 @@ -## gnome-shell-extension-weather - -gnome-shell-extension-weather is a simple extension for displaying weather notifications in Gnome Shell. - -Currently, the weather report including forecast for today and tomorrow is fetched from [Yahoo](http://weather.yahoo.com/). - -### Screenshot - -![Screenshot](https://github.com/ecyrbe/gnome-shell-extension-weather/raw/master/data/screenshot.png) - -### Installation - -From the command line -1. ./autogen.sh --prefix="/usr" -2. make -3. sudo make install - -that's it! - -### Configuration - -Gnome extension weather use gsettings to save your configuration -You can modify the temperature unit with the following command - -. gsettings set org.gnome.shell.extensions.weather unit 'celsius' - - or - -. gsettings set org.gnome.shell.extensions.weather unit 'fahrenheit' - -You can specify your location buy using this command, (cf. [WOEID](http://developer.yahoo.com/geo/geoplanet/guide/concepts.html)) - -. gsettings set org.gnome.shell.extensions.weather woeid 'your location' - -Sometimes your woeid location isn't quite right. it's the next major city around. to customise the displayed city you can type : - -. gsettings set org.gnome.shell.extensions.weather city 'your city' - -### Restart Gnome-Shell - -Don't forget to restart Gnome-Shell - -1. Restart Gnome Shell (`[Alt]+[F2]`, `r`) -2. Fork this project as you like - -### Licence - -Copyright (C) 2011 -Ecyrbe , -Timur Kristóf , -Elad Alfassa , -Simon Legner - -This file is part of gnome-shell-extension-weather. - -gnome-shell-extension-weather is free software: you can redistribute it and/or modify it under the terms of the **GNU General Public License as published by the Free Software Foundation, either version 3** of the License, or (at your option) any later version. - -gnome-shell-extension-weather is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - -You should have received a copy of the GNU General Public License along with gnome-shell-extension-weather. If not, see . - diff --git a/README.md b/README.md index 48e957e..ef81098 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,25 @@ gnome-shell-extension-weather is a simple extension for displaying weather notifications in Gnome Shell. -Currently, the weather report including forecast for today and tomorrow is fetched from [Yahoo](http://weather.yahoo.com/). +Currently, the weather report including forecast for today and tomorrow is fetched from [Yahoo! Weather](http://weather.yahoo.com/). ### Screenshots -![Screenshot](https://github.com/ecyrbe/gnome-shell-extension-weather/raw/master/data/screenshot.png) +![Screenshot](https://github.com/simon04/gnome-shell-extension-weather/raw/master/data/screenshot.png) -And with french translation: +And with French translation: -![Screenshot](https://github.com/ecyrbe/gnome-shell-extension-weather/raw/master/data/screenshot2.png) +![Screenshot](https://github.com/simon04/gnome-shell-extension-weather/raw/master/data/screenshot2.png) ### Installation -From the command line +For installation, run the following commands: -1. ./autogen.sh --prefix="/usr" -2. make -3. sudo make install +```bash +./autogen.sh --prefix=/usr +make +sudo make install +``` That's it! @@ -26,37 +28,34 @@ That's it! Gnome extension weather use gsettings to save your configuration. you can use dconf-editor or gsettings from the command line to modify some parameters -#### Location (cf [WOEID](http://developer.yahoo.com/geo/geoplanet/guide/concepts.html)) +#### Location (cf. [WOEID](http://developer.yahoo.com/geo/geoplanet/guide/concepts.html)) You can specify your location buy using this command: ```bash -gsettings set org.gnome.shell.extensions.weather woeid 'your location' +gsettings set org.gnome.shell.extensions.weather woeid your_woeid ``` #### Temperature units (optional, celsius by default) -You can modify the temperature unit with the following command +You can modify the temperature unit with one of the following commands: ```bash - gsettings set org.gnome.shell.extensions.weather unit 'celsius' - ``` - or - -```bash -gsettings set org.gnome.shell.extensions.weather unit 'fahrenheit' +gsettings set org.gnome.shell.extensions.weather unit celsius +gsettings set org.gnome.shell.extensions.weather unit fahrenheit ``` #### Displayed location (optional) -Sometimes your woeid location isn't quite right. it's the next major city around. to customise the displayed city you can type : +Sometimes your WOEID location isn't quite right (it's the next major city around). To customise the displayed city you can type: ```bash -gsettings set org.gnome.shell.extensions.weather city 'your city' +gsettings set org.gnome.shell.extensions.weather city your_city ``` + ### Restart Gnome-Shell -Don't forget to restart Gnome-Shell +Don't forget to restart GNOME Shell: 1. Restart Gnome Shell (`[Alt]+[F2]`, `r`) 2. Fork this project as you like