Merge pull request pelias#78 from pelias/documentation-updates

Documentation updates

Author: orangejulius

README.md

@@ -7,22 +7,24 @@ This repository contains a framework for downloading/preparing and building the
 
 Example projects are included in the [projects](https://github.com/pelias/docker/tree/master/projects) directory.
 
-We recommend you start with the `portland-metro` example as a first-time user; once you have successfully completed a build you can use this as a base to create your own projects.
+We recommend you start with the `portland-metro` example as a first-time user: it has lower disk and time requirements and can be used to help you familiarize yourself with the process.
 
-## Not suitable for large geographies
-
-We do not recommend running large extracts (anything larger than a US State) inside Docker, the scripts are **not suitable** for full planet builds. If you require global coverage, please see our [install documentation](https://github.com/pelias/documentation/blob/master/getting_started_install.md) or consider using the [geocode.earth](https://geocode.earth/) services hosted by members of our core team.
+Once you have successfully completed a small build you can use this as a base to create your own projects or move on to larger projects.
 
 ## Prerequisites
 
 You will need to have `docker` and `docker-compose` installed before continuing. If you are not using the latest version, please mention that in any bugs reports.
 
-For Mac OSX platform :
-- You should additionally install `brew install coreutils`.
-- Max-out the computing resources( `Memory-RAM and CPUs-Cores` ) dedicated to Docker in `Docker > Preferences > Advanced`. 
+## Requirements for Mac OSX:
+- install GNU coreutils with [Homebrew](https://brew.sh/): `brew install coreutils`.
+- Max-out Docker computing resources( `Memory-RAM and CPUs-Cores` ) dedicated to Docker in `Docker > Preferences > Advanced`.
+
+## System requirements
 
 Scripts can easily download tens of GB of geographic data, so ensure you have enough free disk space!
 
+At least 8GB RAM is required.
+
 ## Installing the Pelias command
 
 If you haven't done so already, you will need to ensure the `pelias` command is available on your path.

projects/planet/README.md

@@ -3,11 +3,23 @@
 
 This project is configured to download/prepare/build a complete Pelias installation for the entire planet.
 
-### Requirements:
+### Minimum Requirements
 * 600GB Disk
 * 16GB RAM
 * 16+ CPU cores or a lot of patience
 
+### Recommended requirements:
+
+* 600GB fast disk (such as NVMe SSD)
+* 48GB RAM
+* 36 CPU cores
+
+## Time requirements
+
+With a 36 CPU machine and fast network connection, full planet builds can take as little as 16 hours.
+
+It's not recommended to run full planet builds on consumer hardware (such as a standard 8 core, 16GB RAM laptop or desktop) unless you are willing to wait up to 72 hours.
+
 ## Setup
 
 Please refer to the instructions at https://github.com/pelias/docker in order to install and configure your docker environment.