LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

more minor clarifications

Browse Source
This commit is contained in:
Andrew Brown
2011-10-26 22:00:25 -04:00
parent a470ff50d6
commit b31160e3ad
2 changed files with 24 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/building.rst
View File

@@ -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 <https://github.com/overviewer/Minecraft-Overviewer/tarball/master>`_
* `Download most recent zip archive <https://github.com/overviewer/Minecraft-Overviewer/zipball/master>`_
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

15
docs/index.rst
View File

@@ -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 <building>` or :doc:`Installing
<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 <building>` or :doc:`Installing <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 <building>` page.
.. _Github Homepage: https://github.com/overviewer/Minecraft-Overviewer
**For all other platforms** you will need to build it yourself.
:doc:`building`.
Help
====