Added high-level summary of pptk to README.md.

Author: victoriousluser

README.md

@@ -1,8 +1,20 @@
 # pptk - Point Processing Toolkit
 
-Copyright (C) 2011-2017 HERE Europe B.V.
+Copyright (C) 2011-2018 HERE Europe B.V.
 
-pptk is a Python package for facilitating point cloud processing in Python.
+The Point Processing Toolkit (pptk) is a Python package for visualizing and processing 2-d/3-d point clouds.
+
+At present, pptk consists of the following features.
+
+* A 3-d point cloud viewer that
+  - accepts any 3-column numpy array as input,
+  - renders tens of millions of points interactively using an octree-based level of detail mechanism,
+  - supports point selection for inspecting and annotating point data.
+* A fully parallelized point k-d tree that supports k-nearest neighbor queries and r-near range queries
+  (both build and queries have been parallelized).
+* A normal estimation routine based on principal component analysis of point cloud neighborhoods.
+
+[Homepage](https://heremaps.github.io/pptk/index.html)
 
 ## License
 
@@ -23,6 +35,30 @@ or from the .whl file that results from [building pptk from source](#build).
 >> pip install <.whl file>
 ```
 
+## Quickstart
+
+In Python, generate 100 random 3-d points.
+
+```
+>> import numpy as np
+>> x = np.random.rand(100, 3)
+```
+
+Visualize.
+
+```
+>> import pptk
+>> v = pptk.viewer(x)
+```
+
+Set point size to 0.01.
+
+```
+>> v.set(point_size=0.01)
+```
+
+For more advanced examples, see [tutorials](https://heremaps.github.io/pptk/tutorial.html).
+
 ## Build
 
 We provide CMake scripts for automating most of the build process, but ask the

docs/source/_templates/layout.html

@@ -31,7 +31,7 @@
         {%- endif -%}
         <h1 class="heading"><a href="{{ pathto('index') }}">
           <span>{{ shorttitle|e }}</span></a></h1>
-        <h2 class="heading"><span>Point Processing Tool Kit</span></h2>
+        <h2 class="heading"><span>Point Processing Toolkit</span></h2>
         {%- endif %}
         {%- endblock %}
       </div>

docs/source/install.rst

@@ -4,11 +4,15 @@ Installing pptk
 Install from PyPI
 -----------------
 
-One can either install pptk directly from PyPI
+Install pptk directly from PyPI
 
     >>> pip install pptk
 
-or from the .whl file that results from 
+.. note::
+   pptk requires 64-bit Python and is only :code:`pip install`-able on versions of Python
+   that have a corresponding pptk wheel file on `PyPI <https://pypi.org/project/pptk/>`__.
+
+Or install from the .whl file that results from
 :ref:`building pptk from source <build_from_source>`.
 
     >>> pip install <.whl file>

docs/source/quickstart.rst

@@ -7,7 +7,7 @@ Install pptk.
 
 .. note::
    pptk requires 64-bit Python and is only :code:`pip install`-able on versions of Python
-   that have a corresponding pptk wheel file on PyPI.
+   that have a corresponding pptk wheel file on `PyPI <https://pypi.org/project/pptk/>`__.
 
 In Python, generate 100 random 3-d points, and