Clarify instructions by source
@@ -17,7 +17,9 @@ This library is licensed under the Apache License, Version 2.
# Installation
-## From a Tarball
+## From a Named Release Tarball
+
+**NOTE:** These instructions are for installation from the _named_ `.tar.gz` tarballs on the [Releases](https://github.com/maxmind/libmaxminddb/releases) page (e.g. `libmaxminddb-*.tar.gz`).
This code is known to work with GCC 4.4+ and clang 3.2+. It should also work
on other compilers that supports C99, POSIX.1-2001, and the `-fms-extensions
@@ -46,20 +48,19 @@ can do this by running the following commands:
$ sudo sh -c "echo /usr/local/lib >> /etc/ld.so.conf.d/local.conf"
$ ldconfig
-## From the Git Repository
+## From a GitHub "Source Code" Archive / Git Repo Clone (Achtung!)
-To install from Git, you will need automake, autoconf, and libtool installed
-in addition to make and a compiler.
+**NOTE:** These instructions are for installation from the GitHub "Source Code" archives also available on the [Releases](https://github.com/maxmind/libmaxminddb/releases) page (e.g. `X.Y.Z.zip` or `X.Y.Z.tar.gz`), as well as installation directly from a clone of the [Git repo](https://github.com/maxmind/libmaxminddb). Installation from these sources are possible, but will present challenges to users not comfortable with manual dependency resolution.
-Our public git repository is hosted on GitHub at
-https://github.com/maxmind/libmaxminddb
+To install from a source code archive, you will need `automake`, `autoconf`, and `libtool` installed
+in addition to `make` and a compiler.
You can clone this repository and build it by running:
$ git clone --recursive https://github.com/maxmind/libmaxminddb
After cloning, run `./bootstrap` from the `libmaxminddb` directory and then
-follow the instructions for installing from a tarball as described above.
+follow the instructions for installing from a named release tarball as described above.
## On Windows via Visual Studio 2013+
