LogalDeveloper/Minecraft-Overviewer
Archived
0
Fork 0
Code Activity

imporoved doc page cross-referencing

Browse Source
This commit is contained in:
Andrew Brown
2011-10-26 21:19:53 -04:00
parent aa7a837043
commit f07cf1e0d8
3 changed files with 18 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/building.rst
View File

@@ -2,11 +2,15 @@
Building the Overviewer from Source Building the Overviewer from Source
=================================== ===================================
These instructions are for building the C extension for Overviewer. Also note These instructions are for building the C extension for Overviewer. Once you
that pre-built Windows and Debian executables are available in the `Downloads have finished with these instructions, head to :doc:`running`.
<https://github.com/overviewer/Minecraft-Overviewer/downloads>`_ section. These
kits already contain the compiled extension and require no further setup (so you .. note::
can skip to the :doc:`Running <running>` section of the docs).
Pre-built Windows and Debian executables are available on the
:doc:`installing` page. These kits already contain the compiled code and
require no further setup, so you can skip to the next section of the docs:
:doc:`running`.
Get The Source Get The Source
============== ==============

8
docs/index.rst
View File

@@ -54,8 +54,10 @@ 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. * Either a Minecraft Client installed or a terrain.png for the textures.
There are additional requirements for compiling it. More details are available The first three are included in the Windows binary download. Also, there are
in either the :doc:`Building <building>` or :doc:`Installing <installing>` pages. 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 Getting Started
=============== ===============
@@ -92,8 +94,8 @@ Documentation Contents
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
building
installing installing
building
running running
options options
faq faq

8
docs/installing.rst
View File

@@ -3,8 +3,9 @@ Installing
========== ==========
This page is for installing the pre-compiled binary versions of the Overviewer. This page is for installing the pre-compiled binary versions of the Overviewer.
If you have built the Overviewer from source yourself, head back to If you want to build the Overviewer from source yourself, head to :doc:`Building
:doc:`Building <building>`. <building>`. If you have already built The Overviewer, proceed to
:doc:`running`.
Windows Windows
@@ -18,8 +19,7 @@ right place!
For 64 bit, you'll want these instead: `VC++ 2008 <http://www.microsoft.com/downloads/en/details.aspx?familyid=bd2a6171-e2d6-4230-b809-9a8d7548c1b6>`_ and `VC++ 2010 <http://www.microsoft.com/download/en/details.aspx?id=14632>`_ For 64 bit, you'll want these instead: `VC++ 2008 <http://www.microsoft.com/downloads/en/details.aspx?familyid=bd2a6171-e2d6-4230-b809-9a8d7548c1b6>`_ and `VC++ 2010 <http://www.microsoft.com/download/en/details.aspx?id=14632>`_
3. That's it! Proceed with instructions on :doc:`Running <running>` the 3. That's it! Proceed with instructions on :doc:`running`.
Overviewer.
Debian / Ubuntu Debian / Ubuntu
=============== ===============