From d586439bb79b6313ed2d1d62809377cdbf08f0ee Mon Sep 17 00:00:00 2001 From: Josh Baker Date: Sun, 3 Apr 2016 08:57:07 -0700 Subject: [PATCH] Added Getting Started section --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b4ad0ccf..e4cc55f9 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,16 @@ Tile38 is an open source (MIT licensed), in-memory geolocation data store, spati - `tile38-server ` - The server - `tile38-cli ` - Command line interface tool -## Building Tile38 +## Getting Started + +### Getting Tile38 + +The easiest way to get Tile38 is to use one of the pre-built release binaries which are available for OSX, Linux, and Windows. Instructions for using these binaries are on the GitHub [releases page](https://github.com/tidwall/tile38/releases). + +If you want to try the latest version, you can build Tile38 from the master branch. + +### Building Tile38 + Tile38 can be compiled and used on Linux, OSX, Windows, FreeBSD, and probably others since the codebase is 100% Go. We support both 32 bit and 64 bit systems. [Go](https://golang.org/dl/) must be installed on the build machine. To build everything simply: