From a9a66450c66f2660efe03a3e99df8fb7a32633b1 Mon Sep 17 00:00:00 2001 From: Ted Steiner Date: Mon, 22 Jun 2015 10:51:56 -0400 Subject: [PATCH] Added an explanatory note about test failures Added an explanatory note that the tests fail on Julia 0.4 but should not affect users. --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fafa296..7863691 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ This package provides basic functionality for parsing, viewing, and working with [OpenStreetMap](http://www.openstreetmap.org) map data. The package is intended mainly for researchers who want to incorporate this rich, global data into their work, and has been designed with both speed and simplicity in mind, especially for those who might be new to Julia. +**Note:** Our automated tests currently fail on Julia 0.4, but these problems appear to be contained to the test system and are caused by a dependent package. OpenStreetMap.jl should run without issue on both Julia 0.3 and 0.4. + ### Capabilities * Parse an [OpenStreetMap XML datafile](http://wiki.openstreetmap.org/wiki/OSM_XML) (OSM files) * Crop maps to specified boundaries @@ -37,13 +39,14 @@ Pkg.add("OpenStreetMap") ``` ##### Dependencies -The following packages should automatically be added as "additional packages", if you do not already have them: +The following packages will automatically be added as "additional packages", if you do not already have them: +* Geodesy.jl: Map coordinate transforms, formerly part of OpenStreetMap.jl * LightXML.jl: parsing OpenStreetMap datafiles * LibExpat.jl: streaming OpenStreetMap datafiles * Winston.jl: map plotting * Graphs.jl: map routing -**Note:** LightXML.jl relies on *libxml2*, which is shipped with Mac OS X and many Linux systems. So this package may work out of the box. If not, check whether you have *libxml2* installed and whether *libxml2.so* (for Linux) or *libxml2.dylib* (for Mac) is on your library search path. I have tested it to work out of the box in Mac OS X 10.9 (Mavericks), Ubuntu 14.04, and Windows 7. Winston.jl has a few additional dependencies, which it should resolve automatically. All other code is written in native Julia. +**Note:** LightXML.jl relies on *libxml2*, which is shipped with Mac OS X and many Linux systems. So this package may work out of the box. If not, check whether you have *libxml2* installed and whether *libxml2.so* (for Linux) or *libxml2.dylib* (for Mac) is on your library search path. I have tested it to work out of the box in Mac OS X 10.9 and 10.10 (Mavericks and Yosemite), Ubuntu 14.04, and Windows 7. Winston.jl has a few additional dependencies, which it should resolve automatically. All other code is written in native Julia. ### Package Status and Contributions All the functionality that I personally need for my work is now implemented in this package, and I am running out of ideas for additional functionality. Therefore, future updates will mostly depend on GitHub issues (bug reports or feature requests) created by users. Pull requests for additional functionality are very welcome, as well.