Skip to content
This repository was archived by the owner on Jun 10, 2024. It is now read-only.

Commit 5cb533d

Browse files
committed
Updated dependency information.
1 parent 590d4d4 commit 5cb533d

File tree

1 file changed

+58
-45
lines changed

1 file changed

+58
-45
lines changed

README.md

Lines changed: 58 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ C++ library.
1010
[![Coverage Status](https://coveralls.io/repos/osmcode/node-osmium/badge.svg?branch=coverage)](https://coveralls.io/r/osmcode/node-osmium?branch=coverage)
1111
[![Dependencies](https://david-dm.org/osmcode/node-osmium.png)](https://david-dm.org/osmcode/node-osmium)
1212

13+
1314
## Should you use node-osmium?
1415

1516
If you want top performance use libosmium directly in C++. These node-osmium
@@ -19,6 +20,7 @@ extracts and prototyping. For large extracts or planet processing we recommend
1920
leveraging the [libosmium C++ API](http://docs.osmcode.org/libosmium-manual/)
2021
instead of using node-osmium.
2122

23+
2224
## Is node-osmium actively developed?
2325

2426
@springmeyer and @joto are maintaining node-osmium but not actively adding
@@ -29,12 +31,61 @@ maintain.
2931

3032
## Depends
3133

32-
- Node.js v0.10.x, v4.x, or v5.x (v4 and v5 supported only with node-osmium >= 0.5.x)
33-
- libosmium (http://osmcode.org/libosmium, https://github.com/osmcode/libosmium)
34-
- protozero (https://github.com/mapbox/protozero)
35-
(The protozero headers are included in the libosmium repository, so if you used
36-
libosmium from git, protozero is already available.)
34+
- Node.js v0.10.x, v4.x, v5.x, v6.x
35+
(v4 and later supported only with node-osmium >= 0.5.x)
3736
- Mocha (http://visionmedia.github.io/mocha/, for tests)
37+
- Compiler that supports `-std=c++11` (>= clang++ 3.6 || >= g++ 4.8)
38+
- [libosmium](https://github.com/osmcode/libosmium)
39+
(Debian/Ubuntu: libosmium2-dev)
40+
- [protozero](https://github.com/mapbox/protozero)
41+
This is included in the libosmium repository and might or might not
42+
have been installed with it. See the libosmium README.
43+
(Debian/Ubuntu: protozero)
44+
- [Utfcpp](http://utfcpp.sourceforge.net/)
45+
This is included in the libosmium repository and might or might not
46+
have been installed with it. See the libosmium README.
47+
(Debian/Ubuntu: libutfcpp-dev)
48+
- [Boost](http://www.boost.org/) >= 1.55 with development headers
49+
(Debian/Ubuntu: libboost-dev)
50+
- [zlib](http://www.zlib.net/)
51+
(Debian/Ubuntu: zlib1g-dev)
52+
- [expat](http://expat.sourceforge.net/)
53+
Debian/Ubuntu: libexpat1-dev
54+
55+
See also the dependency information for the Osmium library.
56+
57+
Set dependencies up on Ubuntu Precise (12.04) like:
58+
59+
```shell
60+
sudo apt-add-repository --yes ppa:chris-lea/node.js
61+
sudo apt-add-repository --yes ppa:ubuntu-toolchain-r/test
62+
sudo apt-get -y update
63+
sudo apt-get -y install git gcc-4.8 g++-4.8 build-essential nodejs
64+
sudo apt-get -y install libboost-dev zlib1g-dev libexpat1-dev libsparsehash-dev
65+
export CC=gcc-4.8
66+
export CXX=g++-4.8
67+
git clone https://github.com/scrosby/OSM-binary.git
68+
cd OSM-binary/src
69+
make && sudo make install
70+
```
71+
72+
Set dependencies up on OS X like:
73+
74+
```shell
75+
git clone https://github.com/mapnik/mapnik-packaging.git
76+
cd mapnik-packaging/osx
77+
export CXX11=true
78+
source MacOSX.sh
79+
./scripts/build_bzip2.sh
80+
./scripts/build_expat.sh
81+
./scripts/build_google_sparsetable.sh
82+
./scripts/build_boost.sh --with-test --with-program_options
83+
./scripts/build_protobuf.sh
84+
./scripts/build_osm-pbf.sh
85+
# NOTE: in the same terminal then run the build commands
86+
# Or from a different terminal re-run `source MacOSX.sh`
87+
```
88+
3889

3990
## Installing
4091

@@ -81,59 +132,21 @@ Use `make VERBOSE=1` to output compiler calls used etc.
81132
npm install mocha
82133
make test
83134

84-
### Source build dependencies
85-
86-
- Compiler that supports `-std=c++11` (>= clang++ 3.4 || >= g++ 4.8)
87-
- [libosmium](https://github.com/osmcode/libosmium)
88-
- [Boost](http://www.boost.org/) >= 1.46 with development headers
89-
- zlib
90-
91-
See also the dependency information for the Osmium library.
92-
93-
Set dependencies up on Ubuntu Precise (12.04) like:
94-
95-
```shell
96-
sudo apt-add-repository --yes ppa:chris-lea/node.js
97-
sudo apt-add-repository --yes ppa:ubuntu-toolchain-r/test
98-
sudo apt-get -y update
99-
sudo apt-get -y install git gcc-4.8 g++-4.8 build-essential nodejs
100-
sudo apt-get -y install libboost-dev zlib1g-dev libexpat1-dev libsparsehash-dev
101-
export CC=gcc-4.8
102-
export CXX=g++-4.8
103-
git clone https://github.com/scrosby/OSM-binary.git
104-
cd OSM-binary/src
105-
make && sudo make install
106-
```
107-
108-
Set dependencies up on OS X like:
109-
110-
```shell
111-
git clone https://github.com/mapnik/mapnik-packaging.git
112-
cd mapnik-packaging/osx
113-
export CXX11=true
114-
source MacOSX.sh
115-
./scripts/build_bzip2.sh
116-
./scripts/build_expat.sh
117-
./scripts/build_google_sparsetable.sh
118-
./scripts/build_boost.sh --with-test --with-program_options
119-
./scripts/build_protobuf.sh
120-
./scripts/build_osm-pbf.sh
121-
# NOTE: in the same terminal then run the build commands
122-
# Or from a different terminal re-run `source MacOSX.sh`
123-
```
124135

125136
## License
126137

127138
node-osmium is available under the Boost Software License. See LICENSE.txt for
128139
details.
129140

141+
130142
## Contact
131143

132144
Please open bug reports on https://github.com/osmcode/node-osmium/issues. You
133145
can ask questions on the
134146
[OSM developer mailing list](https://lists.openstreetmap.org/listinfo/dev)
135147
or on [OFTC net IRC channel #osm-dev](https://wiki.openstreetmap.org/wiki/Irc).
136148

149+
137150
## Authors
138151

139152
- Dane Springmeyer ([email protected])

0 commit comments

Comments
 (0)