diff --git a/docs/src/quick-start.md b/docs/src/quick-start.md index 7d7065e..703df7f 100644 --- a/docs/src/quick-start.md +++ b/docs/src/quick-start.md @@ -58,14 +58,16 @@ This section outlines a typical import using Docker to run PgOSM Flex. ### Prepare -Create directory for the `.osm.pbf` file and output `.sql` file. These files -are automatically created by PgOSM Flex. +Create a directory to use a common location to share with the Docker container. +This is used to link to the internal path where the `.osm.pbf` file, `.md5` file, +and (optional) output `.sql` files are saved. ```bash mkdir ~/pgosm-data ``` + ### Run Set environment variables for the temporary Postgres connection in Docker. @@ -111,7 +113,6 @@ along with a region/subregion. * Region (`north-america/us`) * Sub-region (`district-of-columbia`) (Optional) - ```bash docker exec -it \ pgosm python3 docker/pgosm_flex.py \ diff --git a/docs/src/readme.md b/docs/src/readme.md index 391e8db..2c6afac 100644 --- a/docs/src/readme.md +++ b/docs/src/readme.md @@ -53,7 +53,9 @@ reaches it EOL support. The Docker image is pinned to osm2pgsql's `master` branch. Users of the Docker image naturally use the latest version of osm2pgsql at the time the Docker image was created. -This project has not been officially tested on Windows. +This project runs entirely in Docker, optionally connecting to an external Postgres instance. +It should work on any typical OS able to run Docker. + ## Minimum Hardware