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