Skip to content

Commit

Permalink
Update README. Moved some infos to manual.
Browse files Browse the repository at this point in the history
  • Loading branch information
joto committed Dec 7, 2016
1 parent 89a90a6 commit 9c54a53
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 29 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -8,5 +8,5 @@ Some rules for contributing to this project:

* We'd love for you to send pull requests for fixes you have made or new features
you have added. Please read the [notes for developers](NOTES_FOR_DEVELOPERS.md)
beforehand which contain some coding guidelines.
beforehand which contains some coding guidelines.

37 changes: 9 additions & 28 deletions README.md
Expand Up @@ -4,15 +4,14 @@ http://osmcode.org/libosmium

A fast and flexible C++ library for working with OpenStreetMap data.

Libosmium works on Linux, Mac OSX and Windows.

[![Build Status](https://secure.travis-ci.org/osmcode/libosmium.svg)](https://travis-ci.org/osmcode/libosmium)
[![Build status](https://ci.appveyor.com/api/projects/status/github/osmcode/libosmium?svg=true)](https://ci.appveyor.com/project/Mapbox/libosmium)

Libosmium is developed on Linux, but also works on OSX and Windows (with some
limitations).
Please see the [Libosmium manual](http://osmcode.org/libosmium/manual.html)
for more details than this README can provide.

There are a few applications that use the Osmium library in the examples
directory. See the [osmium-contrib](http://github.com/osmcode/osmium-contrib)
repository for more example code.

## Prerequisites

Expand All @@ -34,18 +33,14 @@ repository:
* [protozero](https://github.com/mapbox/protozero)
* [utfcpp](http://utfcpp.sourceforge.net/)

If you want (some of) those libraries to be installed along with libosmium
itself when calling `make install`, you have to use the CMake options
`INSTALL_GDALCPP`, `INSTALL_PROTOZERO`, and/or `INSTALL_UTFCPP`.


## Directories

* benchmarks: Some benchmarks checking different parts of Libosmium.

* cmake: CMake configuration scripts.

* doc: Config for documentation.
* doc: Config for API reference documentation.

* examples: Osmium example applications.

Expand All @@ -70,32 +65,18 @@ cmake:

This will build the examples and tests. Call `ctest` to run the tests.

For more see the
[Libosmium Manual](http://osmcode.org/libosmium/manual.html#building-libosmium).
For more detals see the
[Building Libosmium](http://osmcode.org/libosmium/manual.html#building-libosmium)
chapter in the manual.


## Testing

See the
[Libosmium Manual](http://osmcode.org/libosmium/manual.html#running-tests).
[Libosmium Manual](http://osmcode.org/libosmium/manual.html#running-tests)
for instructions.


## Osmium on 32bit Machines

Osmium works well on 64 bit machines, but on 32 bit machines there are some
problems. Be aware that not everything will work on 32 bit architectures.
This is mostly due to the 64 bit needed for node IDs. Also Osmium hasn't been
tested well on 32 bit systems. Here are some issues you might run into:

* Google Sparsehash does not work on 32 bit machines in our use case.
* The `mmap` system call is called with a `size_t` argument, so it can't
give you more than 4GByte of memory on 32 bit systems. This might be a
problem.

Please report any issues you have and we might be able to solve them.


## Switching from the old Osmium

If you have been using the old version of Osmium at
Expand Down

0 comments on commit 9c54a53

Please sign in to comment.