aboutsummaryrefslogtreecommitdiff
path: root/USE.md
blob: 81103d68fecfd6984a012f7c97a31ab1006139ae (plain)

Using these slippy maps

This project is usable in several ways:

  • Quick - faster to prepare but loads slower into web browser
  • Compact - compiled for fast and compact hosting

For both approaches the code must be served via a web server (loading from filesystem directly into web browser does not work).

Quick

Quick serving is handy during development, as changes can be tested without building everything.

Prerequisites

Show needed packages, and install them with APT (i.e. as root):

make list-pkg-code-quick
sudo apt install $ABOVE_PACKAGE_LIST

(or install pkglist-code-minimal for a slightly rough visual result)

Serve

Start a tiny webserver, and open a web browser at the local address it tells you:

make serve-quick

Compact

Compact serving is optimized for production use, e.g. on a public host served with Apache.

Code and data gets compiled together, optimized for the smallest possible size and complexity for each single concrete map.

Prerequisites

Show needed packages, and install them with APT (i.e. as root):

make list-pkg-code
sudo apt install $ABOVE_PACKAGE_LIST

Build

To build functional site but skip image fetching:

make build-compact

To build everything, including image fetching:

make

Serve

Start a tiny webserver, and open a web browser at the local address it tells you:

make serve-quick

For production use, consider to instead setup e.g. Apache to serve directory. The directory is fully self-contained (contain no symlinks to or html links to system-wide code) so can be copied to an external web hosting provider.