Skip to content

Commit

Permalink
Add at least some mainpage for C++ docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
mosra committed Sep 3, 2019
1 parent 9f11ccb commit 556a5a5
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/mainpage.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Copyright (c) Facebook, Inc. and its affiliates.
// This source code is licensed under the MIT license found in the
// LICENSE file in the root directory of this source tree.

namespace esp {

/** @mainpage Habitat Simulator

A flexible, high-performance 3D simulator with configurable agents, multiple
sensors, and generic 3D dataset handling (with built-in support for
MatterPort3D, Gibson, Replica, and other datasets).

When rendering a scene from the Matterport3D dataset, *Habitat-Sim* achieves
several thousand frames per second (FPS) running single-threaded, and reaches
over 10,000 FPS multi-process on a single GPU!

@m_class{m-note m-warning}

@par
Docs are currently very much a work-in-progress and are incomplete :(
* **But it's getting better!**

*/

}

0 comments on commit 556a5a5

Please sign in to comment.