Update docs.

unrealcv · Oct 22, 2017 · 0ed551a · 0ed551a
1 parent 784079e
commit 0ed551a
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 4 deletions.
diff --git a/docs/index1.rst b/docs/index1.rst
@@ -0,0 +1,35 @@
+=======
+Welcome
+=======
+
+UnrealCV helps computer vision researchers build virtual worlds using Unreal Engine 4 (UE4). It extends UE4 with a plugin by providing:
+
+1. a set of UnrealCV commands to interact with the virtual world
+2. Communication between UE4 and an external program, such as Caffe or tensorflow.
+
+.. figure:: images/homepage_teaser.png
+    :align: center
+
+    Images generated from the technical demo :ref:`rr`
+
+Currently, UnrealCV plugin supports UE4 (4.12, 4.13, 4.14) in Windows, Linux and Mac, more details about supported platforms in :ref:`this page <supported>`. UnrealCV client supports python and MATLAB (experimental). Read :doc:`getting started <tutorials/getting_started>` to learn how to use UnrealCV.
+
+Tutorials are provided to help you get familiar with UnrealCV quickly and more technical details are documented in the reference section.
+
+Tutorials
+=========
+
+- :doc:`tutorials/getting_started` - The basics of using UnrealCV, start from here.
+- :doc:`tutorials/generate_images_tutorial` - Generate an image dataset with ground truth.
+- :doc:`tutorials/faster_rcnn` - Show how to use images from a video game for testing faster RCNN.
+- :doc:`plugin/install` - How to install UnrealCV plugin into UE4.
+
+Reference
+=========
+- :doc:`reference/architecture` - Technical details of UnrealCV.
+- :doc:`reference/commands` - All available commands provided in UnrealCV.
+
+For the doc of a specific version of unrealcv, please see `the version page`_
+
+.. _the version page: https://readthedocs.org/projects/unrealcv/versions/
+.. _readthedocs: http://docs.unrealcv.org
diff --git a/docs/reference/commands.rst b/docs/reference/commands.rst
@@ -12,7 +12,9 @@ Command cheatsheet
 
     This command list is growing and subject to change
 
-Reply [this thread](https://groups.google.com/d/topic/unrealcv/EuJlibmTN3c/discussion) to tell us what missing functions are needed for your project. We will consider adding it in the future release.
+See this `ipython notebook <https://github.com/unrealcv/unrealcv/blob/master/examples/commands_demo.ipynb>`__ to see an imcomplete demo of available commands.
+
+.. Reply [this thread](https://groups.google.com/d/topic/unrealcv/EuJlibmTN3c/discussion) to tell us what missing functions are needed for your project. We will consider adding it in the future release.
 
 
 1. Camera operation

diff --git a/docs/tutorials/examples.rst b/docs/tutorials/examples.rst
@@ -1,7 +1,7 @@
 More Examples
 =============
 
-More examples can be found in the examples folder.
+More examples can be found in the `examples folder of the repo <https://github.com/unrealcv/unrealcv/tree/master/examples>`__.
 
 - List of all unrealcv commands - `examples/commands_demo.ipynb <https://github.com/unrealcv/unrealcv/blob/develop/examples/commands_demo.ipynb>`__
 

diff --git a/docs/tutorials/getting_started.rst b/docs/tutorials/getting_started.rst
@@ -11,8 +11,6 @@ This tutorial will use a game binary to demonstrate UnrealCV commands. You can a
 
 First you need to download a game binary from :doc:`our model zoo </reference/model_zoo>`. For this tutorial, please download :ref:`RealisticRendering <rr>`. After unzip and run the binary, you are expected to see a screen like this. The game will be started in a window mode with resolution 640x480, you can change the resolution by :doc:`changing the configuration file </plugin/config>` of UnrealCV.
 
-:ref:`rr`
-
 .. figure:: ../images/rr_init.png
     :width: 300px
     :align: center