Skip to content

Commit cf6b101

Browse files
committed
update feature and installation sections in the README
Also moves the maintainer section here from CONTRIBUTING.md.
1 parent b658828 commit cf6b101

File tree

1 file changed

+34
-24
lines changed

1 file changed

+34
-24
lines changed

README.md

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,35 @@ to install and run osm2pgsql.
1414

1515
## Features
1616

17-
* Converts OSM files to a PostgreSQL DB
18-
* Conversion of tags to columns is configurable in the style file
19-
* Able to read .gz, .bz2, .pbf and .o5m files directly
20-
* Can apply diffs to keep the database up to date
21-
* Support the choice of output projection
22-
* Configurable table names
23-
* Support for hstore field type to store the complete set of tags in one database
24-
field if desired
17+
* freely configurable table layout and content using the LUA scripting language
18+
* support for building geometries in simple feature format and for generalization
19+
* read OSM data from OSM, PBF and O5M formats
20+
* update the database from OSM change files and replication diffs
21+
* usable for importing a small geographic area on a tiny laptop up to
22+
importing the whole world on a large server machine
23+
* runs on Linux, Windows and MacOS
24+
* [and more](https://osm2pgsql.org/about/features/)
2525

2626
## Installing
2727

28-
Most Linux distributions include osm2pgsql. It is available on macOS with
29-
[Homebrew](https://brew.sh/) and Windows builds are also available. See
30-
https://osm2pgsql.org/doc/install.html for details.
28+
* __Linux__: most distributions include osm2pgsql. Debian always offers
29+
the latest version via backports.
30+
* __macOS__: osm2pgsql is available through [Homebrew](https://brew.sh/)
31+
* __Windows__: use our [binary builds](https://osm2pgsql.org/download/windows/)
32+
33+
For detailed instructions, visit
34+
the [Installation page](https://osm2pgsql.org/doc/install.html).
3135

3236
## Building
3337

3438
The latest source code is available in the osm2pgsql git repository on GitHub
3539
and can be downloaded as follows:
3640

3741
```sh
38-
git clone https://github.com/openstreetmap/osm2pgsql.git
42+
git clone https://github.com/osm2pgsql-dev/osm2pgsql.git
3943
```
4044

41-
Osm2pgsql uses the cross-platform [CMake build system](https://cmake.org/)
45+
osm2pgsql uses the cross-platform [CMake build system](https://cmake.org/)
4246
to configure and build itself.
4347

4448
Required libraries are
@@ -50,16 +54,16 @@ Required libraries are
5054
* [zlib](https://www.zlib.net/)
5155
* [Boost libraries](https://www.boost.org/) (for boost geometry)
5256
* [nlohmann/json](https://json.nlohmann.me/)
53-
* [OpenCV](https://opencv.org/) (Optional, for generalization only)
54-
* [potrace](https://potrace.sourceforge.net/) (Optional, for generalization only)
55-
* [PostgreSQL](https://www.postgresql.org/) client libraries
57+
* [PostgreSQL](https://www.postgresql.org/) client library
5658
* [Lua](https://www.lua.org/)
59+
* [OpenCV](https://opencv.org/) (optional, for generalization only)
60+
* [potrace](https://potrace.sourceforge.net/) (optional, for generalization only)
5761
* [Python](https://python.org/) (only for running tests)
5862
* [Psycopg](https://www.psycopg.org/) (only for running tests)
5963

6064
The following libraries are included in the `contrib` directory. You can build
61-
with other versions of those libraries (set the `EXTERNAL_*libname*` option to
62-
`ON`) but make sure you are using a compatible version:
65+
with other versions of those libraries (set the `EXTERNAL_*libname*` CMake
66+
option to `ON`) but make sure you are using a compatible version:
6367

6468
* [fmt](https://fmt.dev/) (>= 7.1.3)
6569
* [libosmium](https://osmcode.org/libosmium/) (>= 2.17.0)
@@ -73,7 +77,7 @@ Make sure you have installed the development packages for the libraries
7377
mentioned in the requirements section and a C++ compiler which supports C++17.
7478
We officially support gcc >= 10.0 and clang >= 13.
7579

76-
To rebuild the included man page you'll need the [pandoc](https://pandoc.org/)
80+
To rebuild the included man page you need the [pandoc](https://pandoc.org/)
7781
tool.
7882

7983
First install the dependencies.
@@ -150,8 +154,8 @@ The compiled files can be installed with
150154
sudo make install
151155
```
152156

153-
By default, the Release build with debug info is created and no tests are
154-
compiled. You can change that behavior by using additional options like
157+
By default, a Release build with debug info is created and tests are
158+
disabled. You can change that behavior by using additional options like
155159
following:
156160

157161
```sh
@@ -163,12 +167,13 @@ Note that `Debug` builds will be much slower than release build. For production
163167

164168
### Using the PROJ library
165169

166-
Osm2pgsql has builtin support for the Latlong (WGS84, EPSG:4326) and the
170+
osm2pgsql has builtin support for the Latlong (WGS84, EPSG:4326) and the
167171
WebMercator (EPSG:3857) projection. Other projections are supported through
168-
the [Proj library](https://proj.org/) which is used by default. Set the CMake
172+
the [Proj library](https://proj.org/). Support will be automatically compiled
173+
in, when CMake can find the library in the system. Set the CMake
169174
option `WITH_PROJ` to `OFF` to disable use of that library.
170175

171-
## Using LuaJIT
176+
### Using LuaJIT
172177

173178
To speed up Lua tag transformations, [LuaJIT](https://luajit.org/) can be
174179
optionally enabled on supported platforms. This can speed up processing
@@ -216,6 +221,11 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
216221
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
217222
GNU General Public License for more details.
218223

224+
## Maintainers
225+
226+
The current maintainers of osm2pgsql are [Sarah Hoffmann](https://github.com/lonvia/)
227+
and [Paul Norman](https://github.com/pnorman/).
228+
219229
## Contributing
220230

221231
We welcome contributions to osm2pgsql. See [CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)