Operating system checks and QUICKSTART.md improvements

QUICKSTART.md

@@ -3,12 +3,34 @@
 ## Quickstart - for small extracts
 
 ### Req:
-* linux x86_64
+* CPU: AMD64 ( = Intel 64 bit)
-* docker         >=1.10
+    *  The base docker debian images are x86_64 based, so the ARM,MIPS currently not supported!
-* docker-compose >=1.7.1
+* Operating system
+    * Linux is suggested
+        * The development and the testing platform is Linux.
+    * If you are using FreeBSD, Solaris, Windows, ...
+        * Please give a feedback, share your experience, write a tutorial
+* bash
 * git
-* free disk space >= ~15Gb ( more is better! )
+* make 
+* docker         >=1.10
+    * https://www.docker.com/products/overview
+* docker-compose >=1.7.1
+    * https://docs.docker.com/compose/install/
+* disk space ( >= ~15Gb  )
+    * for small extracts  >= ~15Gb
+    * for big extracts ( continents, planet) > 20 ... 1000 Gb
+    * And depends on
+        * OpenStreetMap data size
+        * Zoom level
+* memory ( >= 3Gb )
+    * for small extracts 3Gb-8Gb RAM
+    * for big extracts ( Europe, Planet) > 8-32 Gb
+* internet connections
+    * for downloading docker images
+    * for downloading OpenStreetMap data from Geofabrik
 
+Important:  The ./quickstart.sh is for small extracts - not optimal for a Planet rendering !!
 
 ### First experiment - with albania ( small extracts! )
 
@@ -18,15 +40,24 @@ cd openmaptiles
 ./quickstart.sh
 ```
 
-if you have problems check the ./quickstart.log! 
+If you have problems with the quickstart
-
+* check the ./quickstart.log!
- 
+* check again the system requirements
+* check the current issues : https://github.com/openmaptiles/openmaptiles/issues 
+* create new issues: 
+    * create a new gist https://gist.github.com/ from your ./quickstart.log
+    * double check: if this is not contain any sensitive informations about your system   
+    * create a new issues: https://github.com/openmaptiles/openmaptiles/issues
+        * describe the problems  
+        * add any important informations your environment 
+        * and link your (quickstart.log) gist !
     
 ### Check other extracts
 
 IF the previous step is working,
 THAN you can test other available quickstart extracts ( based on geofabrik extracts) !
  * We are using https://github.com/julien-noblet/download-geofabrik tool
+ * The current extract list, and more informations  ->  `make list`
 
 This is generating mbtiles for your area :  [ MIN_ZOOM: "0"  - MAX_ZOOM: "7" ]
 
@@ -249,3 +280,9 @@ modify the settings in the `.env`  file
 
 and re-start  `./quickstart.sh `
 *  the new config file re-generating to here  ./data/docker-compose-config.yml
+
+Hints: 
+* Small increments! Never starts with the MAX_ZOOM = 14
+* The suggested  MAX_ZOOM = 14  - use only with small extracts
+
+

quickstart.sh

@@ -47,28 +47,37 @@ echo "====> : OpenMapTiles quickstart! [ https://github.com/openmaptiles/openmap
 echo "      : This will be logged to the $log_file file ( for debugging ) and to the screen"
 echo "      : Git version: $githash  / Started: $STARTDATE "
 echo "      : Your bash version:  $BASH_VERSION"
-echo "      : Your system is:"
+echo "      : Your OS:  $OSTYPE"
-lsb_release -a
 
-echo " "
-echo "-------------------------------------------------------------------------------------"
-echo "      : This is working on x86_64 ; Your kernel is:"
-uname -r
-uname -m
 
-KERNEL_CPU_VER=$(uname -m)
+if [[ "$OSTYPE" == "linux-gnu" ]]; then
-if [ "$KERNEL_CPU_VER" != "x86_64" ]; then
+
+    echo "      : Your system is:"
+    lsb_release -a
+    echo " "
+    echo "-------------------------------------------------------------------------------------"
+    echo "      : This is working on x86_64 ; Your kernel is:"
+    uname -r
+    uname -m
+
+    KERNEL_CPU_VER=$(uname -m)
+    if [ "$KERNEL_CPU_VER" != "x86_64" ]; then
     echo "ERR: Sorry this is working only on x86_64!"
     exit 1
+    fi
+    echo "      : --- Memory, CPU info ---- "
+    mem=$( grep MemTotal /proc/meminfo | awk '{print $2}' | xargs -I {} echo "scale=4; {}/1024^2" | bc  )
+    echo "system memory (GB): ${mem}  "
+    grep SwapTotal /proc/meminfo
+    echo cpu number: $(grep -c processor /proc/cpuinfo) x $(cat /proc/cpuinfo | grep "bogomips" | head -1)
+    cat /proc/meminfo  | grep Free
+else
+    echo " "
+    echo "Warning : This is not a Linux ...  ( Less tested ... )  "   
+    echo " "
 fi
 
 
-echo "      : --- Memory, CPU info ---- "
-mem=$( grep MemTotal /proc/meminfo | awk '{print $2}' | xargs -I {} echo "scale=4; {}/1024^2" | bc  )
-echo "system memory (GB): ${mem}  "
-grep SwapTotal /proc/meminfo
-echo cpu number: $(grep -c processor /proc/cpuinfo) x $(cat /proc/cpuinfo | grep "bogomips" | head -1)
-cat /proc/meminfo  | grep Free
 
 echo " "
 echo "-------------------------------------------------------------------------------------"