diff --git a/docs/building.rst b/docs/building.rst index f62cb8b..9dbfe27 100644 --- a/docs/building.rst +++ b/docs/building.rst @@ -14,13 +14,18 @@ have finished with these instructions, head to :doc:`running`. Get The Source ============== -First step: download the source! Either clone with Git or download the most recent snapshot -* URL to clone: ``git://github.com/overviewer/Minecraft-Overviewer.git`` +First step: download the platform-independent source! Either clone with Git +(recommended if you know Git) or download the most recent snapshot + +* Git URL to clone: ``git://github.com/overviewer/Minecraft-Overviewer.git`` * `Download most recent tar archive `_ * `Download most recent zip archive `_ +Once you have the source, see below for instructions on building for your +system. + Build Instructions For Various Operating Systems ================================================ @@ -161,5 +166,10 @@ regular user. Installing the Compiled Code ---------------------------- -You can run the ``overviewer.py`` script from the build directory just fine. If -you'd like to install, run ``python setup.py install`` + +You can run the ``overviewer.py`` script from the build directory just fine; +installation is unnecessary. If you'd like to install, run + +:: + + python setup.py install diff --git a/docs/index.rst b/docs/index.rst index c990364..b471a14 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,10 @@ The Minecraft Overviewer ======================== +See also the `Github Homepage`_ + +.. _Github Homepage: https://github.com/overviewer/Minecraft-Overviewer + Introduction ============ The Minecraft Overviewer is a command-line tool for rendering high-resolution @@ -54,10 +58,9 @@ Windows, Mac, and Linux as long as you have these software packages installed: * Either a Minecraft Client installed or a terrain.png for the textures. -The first three are included in the Windows binary download. Also, there are -additional requirements for compiling it (like a compiler). More details are -available in either the :doc:`Building ` or :doc:`Installing -` pages. +The first three are included in the Windows download. Also, there are additional +requirements for compiling it (like a compiler). More details are available in +either the :doc:`Building ` or :doc:`Installing ` pages. Getting Started =============== @@ -73,7 +76,9 @@ packages and don't want to have to compile anything yourself**, head to the **If you would like to build the Overviewer from source yourself (it's not that bad)**, head to the :doc:`Building ` page. -.. _Github Homepage: https://github.com/overviewer/Minecraft-Overviewer +**For all other platforms** you will need to build it yourself. +:doc:`building`. + Help ====