Updated submodules mdwn2text and luadoc-ikiwiki
[metar.git] / README.txt
1                                 Lua METAR parser
2
3    This library can be used to parse METAR coded weather reports and fetch
4    current METAR reports from [1]NOAA [2]Internet Weather Service in Lua.
5
6    The parser is pretty simple and by no means claims to support every
7    feature one might find in METAR coded weather reports. For example,
8    weather forecasts and automatic weather reports are not detected.
9    Unsupported features in the weather reports are silently dropped.
10
11                                   Dependencies
12
13    [3]LuaSocket is required for fetching weather reports from the
14    [4]Internet Weather Service. On Debian/Ubuntu systems you can install
15    the package liblua5.1-socket2 in order to get LuaSocket installed.
16
17    My [5]Lua weather library is required for doing some unit conversions.
18
19                                   Downloading
20
21    METAR parser home page is at [6]http://solitudo.net/software/lua/metar/
22    and it can be downloaded by cloning the public Git repository at
23    git://scm.solitudo.net/metar.git. Gitweb interface is available at
24    [7]http://scm.solitudo.net/gitweb/public/metar.git.
25
26                                   Installation
27
28    Install the src/metar.lua under some of the directories included in the
29    default LUA_PATH for your Lua distribution, or install under desired
30    location and set LUA_PATH accordingly. More info about LUA_PATH at
31    [8]http://www.lua.org/pil/8.1.html.
32
33                                API Documentation
34
35    API documentation for metar is available under the api/ directory of
36    the distribution.
37
38                                    References
39
40    The following material was used when researching METAR
41      * [9]Federal Meteorological Handbook No. 1 - Surface Weather
42        Observations and Reports
43      * [10]Metar codes by Richard Ogley
44      * [11]Meteorology @ West Moors - Metar decode
45      * Source code of [12]GWeather
46      * Source code of [13]Metar
47
48                             Copyright and licensing
49
50    Copyright: © 2011 Tuomas Jormola [14]tj@solitudo.net
51    [15]http://solitudo.net
52
53    Licensed under the terms of the [16]GNU General Public License Version
54    2.0. License terms are included in the file COPYING.
55
56 References
57
58    1. http://www.noaa.gov/
59    2. http://weather.noaa.gov/
60    3. http://www.cs.princeton.edu/~diego/professional/luasocket/
61    4. http://weather.noaa.gov/
62    5. http://solitudo.net/software/lua/weatherlib/
63    6. http://solitudo.net/software/lua/metar/
64    7. http://scm.solitudo.net/gitweb/public/metar.git
65    8. http://www.lua.org/pil/8.1.html
66    9. http://www.ofcm.gov/fmh-1/fmh1.htm
67   10. http://www.astro.keele.ac.uk/oldusers/rno/Aviation/metar_codes.html
68   11. http://booty.org.uk/booty.weather/metinfo/codes/METAR_decode.htm
69   12. http://ftp.gnome.org/pub/GNOME/sources/libgweather/
70   13. http://www.leune.org/metar/
71   14. mailto:tj@solitudo.net
72   15. http://solitudo.net/
73   16. http://www.gnu.org/licenses/gpl-2.0.html