Skip to content

Commit

Permalink
Merge pull request #378 from rustprooflabs/docs-cleanup
Browse files Browse the repository at this point in the history
Fix Windows wording and other minor adjustment
  • Loading branch information
rustprooflabs authored Feb 17, 2024
2 parents 45364ae + b5383b3 commit 775b1ac
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
7 changes: 4 additions & 3 deletions docs/src/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 \
Expand Down
4 changes: 3 additions & 1 deletion docs/src/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 775b1ac

Please sign in to comment.