Skip to content

Commit c313c1b

Browse files
authored
Update README.md
1 parent 529ec70 commit c313c1b

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
# osm-transit-extractor [![Build status](https://travis-ci.org/CanalTP/osm-transit-extractor.svg?branch=master)](https://travis-ci.org/CanalTP/osm-transit-extractor/)
22

3-
Export OSM public transport data.
3+
Extract public transport data from an [OpenStreetMap](http://www.openstreetmap.org/) file, and write the result to a list of csv files.
4+
This tool uses the crate [osmpbfreader](https://github.com/TeXitoi/osmpbfreader-rs) to read the provided [OpenStreetMap PBF
5+
files](http://wiki.openstreetmap.org/wiki/PBF_Format)
6+
7+
## How to use
8+
Run the program with --help to display available parameters. The simplest way to use it is :
9+
`osm-transit-extractor -i name_of_the_osm_file.osm.pbf`
10+
11+
This command will extract the public transport data and write them to CSV files in the current directory. The output directory can be changed with the use of the parameter `-o /path/to/the/dest/directory/`
12+

0 commit comments

Comments
 (0)