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