Converts README from rst to md
This commit is contained in:
parent
4092b2c537
commit
1cef779a6d
2 changed files with 109 additions and 116 deletions
109
README.md
Normal file
109
README.md
Normal file
|
|
@ -0,0 +1,109 @@
|
||||||
|
# cmw
|
||||||
|
|
||||||
|
`cmw` is a command line weather application that queries [wttr.in](https://wttr.in).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ cmw --help
|
||||||
|
usage: cmw [-h] [-L LOCATION] [-f FORMAT] [-l LANG] [-m] [-u] [-M] [-z] [-o]
|
||||||
|
[-w] [-A] [-F] [-n] [-q] [-Q] [-N] [-P] [-p] [-T] [-t TRANSPARENCY]
|
||||||
|
[--v2] [--version]
|
||||||
|
|
||||||
|
Get the weather!
|
||||||
|
|
||||||
|
optional arguments:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
-L LOCATION, --location LOCATION
|
||||||
|
Location (look at epilog for more information)
|
||||||
|
-f FORMAT, --format FORMAT
|
||||||
|
Query formatting
|
||||||
|
-l LANG, --lang LANG The language to use
|
||||||
|
-m, --metric Units: Metric (SI) (default outside US)
|
||||||
|
-u, --uscs Units: USCS (default in US)
|
||||||
|
-M, --meter-second Units: Show wind speed in m/s
|
||||||
|
-z, --zero View: Only current weather
|
||||||
|
-o, --one View: Current weather & one day
|
||||||
|
-w, --two View: Current weather & two days
|
||||||
|
-A, --ignore-user-agent
|
||||||
|
View: Force ANSI output format
|
||||||
|
-F, --follow-link View: Show the 'Follow' line from upstream
|
||||||
|
-n, --narrow View: Narrow version
|
||||||
|
-q, --quiet View: Quiet version
|
||||||
|
-Q, --super-quiet View: Super quiet version
|
||||||
|
-N, --no-colors View: Switch terminal sequences off
|
||||||
|
-P, --png PNG: Generate PNG file
|
||||||
|
-p, --add-frame PNG: Add frame around output
|
||||||
|
-T, --mid-transparency
|
||||||
|
PNG: Make transparency 150
|
||||||
|
-t TRANSPARENCY, --transparency TRANSPARENCY
|
||||||
|
PNG: Set transparency between 0 and 255
|
||||||
|
--v2 v2 interface of the day
|
||||||
|
--version show program's version number and exit
|
||||||
|
|
||||||
|
Supported Location Types
|
||||||
|
------------------------
|
||||||
|
City name: Paris
|
||||||
|
Unicode name: Москва
|
||||||
|
Airport code (3 letters): muc
|
||||||
|
Domain name: @stackoverflow.com
|
||||||
|
Area code: 94107
|
||||||
|
GPS coordinates: -78.46,106.79
|
||||||
|
|
||||||
|
Special Location
|
||||||
|
----------------
|
||||||
|
Moon phase (add ,+US
|
||||||
|
or ,+France
|
||||||
|
for these cities): moon
|
||||||
|
Moon phase for a date: moon@2016-10-25
|
||||||
|
|
||||||
|
Supported languages
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Supported: af da de el et fr fa hu id it nb nl pl pt-br ro ru tr uk vi
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ cmw -L London -z
|
||||||
|
Weather report: london
|
||||||
|
|
||||||
|
\ / Clear
|
||||||
|
.-. 21 °C
|
||||||
|
― ( ) ― ↑ 19 km/h
|
||||||
|
`-’ 10 km
|
||||||
|
/ \ 0.0 mm
|
||||||
|
Location: London [51.509648,-0.099076]
|
||||||
|
```
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ cmw -L London -o
|
||||||
|
Weather report: london
|
||||||
|
|
||||||
|
\ / Clear
|
||||||
|
.-. 21 °C
|
||||||
|
― ( ) ― ↑ 19 km/h
|
||||||
|
`-’ 10 km
|
||||||
|
/ \ 0.0 mm
|
||||||
|
┌─────────────┐
|
||||||
|
┌──────────────────────────────┬───────────────────────┤ Wed 28 Aug ├───────────────────────┬──────────────────────────────┐
|
||||||
|
│ Morning │ Noon └──────┬──────┘ Evening │ Night │
|
||||||
|
├──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┤
|
||||||
|
│ Cloudy │ \ / Partly cloudy │ \ / Partly cloudy │ \ / Partly cloudy │
|
||||||
|
│ .--. 22..25 °C │ _ /"".-. 25 °C │ _ /"".-. 22 °C │ _ /"".-. 19 °C │
|
||||||
|
│ .-( ). ↗ 12-14 km/h │ \_( ). ↗ 14-17 km/h │ \_( ). ↗ 18-21 km/h │ \_( ). ↗ 15-18 km/h │
|
||||||
|
│ (___.__)__) 10 km │ /(___(__) 10 km │ /(___(__) 10 km │ /(___(__) 10 km │
|
||||||
|
│ 0.0 mm | 0% │ 0.0 mm | 0% │ 0.0 mm | 0% │ 0.0 mm | 0% │
|
||||||
|
└──────────────────────────────┴──────────────────────────────┴──────────────────────────────┴──────────────────────────────┘
|
||||||
|
Location: London [51.509648,-0.099076]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Advanced Usage
|
||||||
|
|
||||||
|
```text
|
||||||
|
$ cmw -L London -f "?format=%l:+%c+%t"
|
||||||
|
london: ☀️ +21°C
|
||||||
|
```
|
||||||
|
|
||||||
|
Please check [wttr.in](https://github.com/chubin/wttr.in) for more information.
|
||||||
116
README.rst
116
README.rst
|
|
@ -1,116 +0,0 @@
|
||||||
cmw
|
|
||||||
===
|
|
||||||
|
|
||||||
`cmw` is a command line weather application that queries `wttr.in <https://wttr.in>`_.
|
|
||||||
|
|
||||||
Usage
|
|
||||||
=====
|
|
||||||
|
|
||||||
.. code:: text
|
|
||||||
|
|
||||||
$ cmw --help
|
|
||||||
usage: cmw [-h] [-L LOCATION] [-f FORMAT] [-l LANG] [-m] [-u] [-M] [-z] [-o]
|
|
||||||
[-w] [-A] [-F] [-n] [-q] [-Q] [-N] [-P] [-p] [-T] [-t TRANSPARENCY]
|
|
||||||
[--v2] [--version]
|
|
||||||
|
|
||||||
Get the weather!
|
|
||||||
|
|
||||||
optional arguments:
|
|
||||||
-h, --help show this help message and exit
|
|
||||||
-L LOCATION, --location LOCATION
|
|
||||||
Location (look at epilog for more information)
|
|
||||||
-f FORMAT, --format FORMAT
|
|
||||||
Query formatting
|
|
||||||
-l LANG, --lang LANG The language to use
|
|
||||||
-m, --metric Units: Metric (SI) (default outside US)
|
|
||||||
-u, --uscs Units: USCS (default in US)
|
|
||||||
-M, --meter-second Units: Show wind speed in m/s
|
|
||||||
-z, --zero View: Only current weather
|
|
||||||
-o, --one View: Current weather & one day
|
|
||||||
-w, --two View: Current weather & two days
|
|
||||||
-A, --ignore-user-agent
|
|
||||||
View: Force ANSI output format
|
|
||||||
-F, --follow-link View: Show the 'Follow' line from upstream
|
|
||||||
-n, --narrow View: Narrow version
|
|
||||||
-q, --quiet View: Quiet version
|
|
||||||
-Q, --super-quiet View: Super quiet version
|
|
||||||
-N, --no-colors View: Switch terminal sequences off
|
|
||||||
-P, --png PNG: Generate PNG file
|
|
||||||
-p, --add-frame PNG: Add frame around output
|
|
||||||
-T, --mid-transparency
|
|
||||||
PNG: Make transparency 150
|
|
||||||
-t TRANSPARENCY, --transparency TRANSPARENCY
|
|
||||||
PNG: Set transparency between 0 and 255
|
|
||||||
--v2 v2 interface of the day
|
|
||||||
--version show program's version number and exit
|
|
||||||
|
|
||||||
Supported Location Types
|
|
||||||
------------------------
|
|
||||||
City name: Paris
|
|
||||||
Unicode name: Москва
|
|
||||||
Airport code (3 letters): muc
|
|
||||||
Domain name: @stackoverflow.com
|
|
||||||
Area code: 94107
|
|
||||||
GPS coordinates: -78.46,106.79
|
|
||||||
|
|
||||||
Special Location
|
|
||||||
----------------
|
|
||||||
Moon phase (add ,+US
|
|
||||||
or ,+France
|
|
||||||
for these cities): moon
|
|
||||||
Moon phase for a date: moon@2016-10-25
|
|
||||||
|
|
||||||
Supported languages
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
Supported: af da de el et fr fa hu id it nb nl pl pt-br ro ru tr uk vi
|
|
||||||
|
|
||||||
|
|
||||||
Example
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. code:: text
|
|
||||||
|
|
||||||
$ cmw -L London -z
|
|
||||||
Weather report: london
|
|
||||||
|
|
||||||
\ / Clear
|
|
||||||
.-. 21 °C
|
|
||||||
― ( ) ― ↑ 19 km/h
|
|
||||||
`-’ 10 km
|
|
||||||
/ \ 0.0 mm
|
|
||||||
Location: London [51.509648,-0.099076]
|
|
||||||
|
|
||||||
|
|
||||||
.. code:: text
|
|
||||||
|
|
||||||
$ cmw -L London -o
|
|
||||||
Weather report: london
|
|
||||||
|
|
||||||
\ / Clear
|
|
||||||
.-. 21 °C
|
|
||||||
― ( ) ― ↑ 19 km/h
|
|
||||||
`-’ 10 km
|
|
||||||
/ \ 0.0 mm
|
|
||||||
┌─────────────┐
|
|
||||||
┌──────────────────────────────┬───────────────────────┤ Wed 28 Aug ├───────────────────────┬──────────────────────────────┐
|
|
||||||
│ Morning │ Noon └──────┬──────┘ Evening │ Night │
|
|
||||||
├──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┤
|
|
||||||
│ Cloudy │ \ / Partly cloudy │ \ / Partly cloudy │ \ / Partly cloudy │
|
|
||||||
│ .--. 22..25 °C │ _ /"".-. 25 °C │ _ /"".-. 22 °C │ _ /"".-. 19 °C │
|
|
||||||
│ .-( ). ↗ 12-14 km/h │ \_( ). ↗ 14-17 km/h │ \_( ). ↗ 18-21 km/h │ \_( ). ↗ 15-18 km/h │
|
|
||||||
│ (___.__)__) 10 km │ /(___(__) 10 km │ /(___(__) 10 km │ /(___(__) 10 km │
|
|
||||||
│ 0.0 mm | 0% │ 0.0 mm | 0% │ 0.0 mm | 0% │ 0.0 mm | 0% │
|
|
||||||
└──────────────────────────────┴──────────────────────────────┴──────────────────────────────┴──────────────────────────────┘
|
|
||||||
Location: London [51.509648,-0.099076]
|
|
||||||
|
|
||||||
|
|
||||||
Advanced Usage
|
|
||||||
==============
|
|
||||||
|
|
||||||
.. code:: text
|
|
||||||
|
|
||||||
$ cmw -L London -f "?format=%l:+%c+%t"
|
|
||||||
london: ☀️ +21°C
|
|
||||||
|
|
||||||
Please check `wttr.in <https://github.com/chubin/wttr.in>`_ for more information.
|
|
||||||
Loading…
Reference in a new issue