README.md
1
2# Osmium example programs
3
4The programs in this directory are intended as examples for developers. They
5contain extensive comments explaining what's going on. Note that the examples
6only cover a small part of what Osmium can do, you should also read the manuals
7and API documentation.
8
9All programs can be run without arguments and they will tell you how to use
10them.
11
12## Very simple examples
13
14* `osmium_read`
15* `osmium_count`
16* `osmium_debug`
17* `osmium_tiles`
18
19## Still reasonably simple examples
20
21* `osmium_amenity_list`
22* `osmium_read_with_progress`
23* `osmium_filter_discussions`
24* `osmium_convert`
25* `osmium_pub_names`
26* `osmium_road_length`
27
28## More advanced examples
29
30* `osmium_area_test`
31* `osmium_create_pois`
32* `osmium_tags_filter`
33
34## Even more advanced examples
35
36* `osmium_change_tags`
37* `osmium_location_cache_create`
38* `osmium_location_cache_use`
39* `osmium_dump_internal`
40* `osmium_index_lookup`
41
42## License
43
44The code in these example files is released into the Public Domain. Feel free
45to copy the code and build on it.
46
47