Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
qiuwch committed Dec 1, 2016
1 parent 6a834f9 commit 8b668a4
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/basic/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Use mouse to look around and use keys `wasd` to navigate, use `qe` to level the

UnrealCV provides a set of commands for computer vision research. These commands are used to perform various tasks, such as control camera and get ground truth. The table below summaries commands used in this tutorial. The complete list can be found in [Reference: Command List](/reference/commands.html).

<!-- TODO: consider making this external -->
| Command | Help |
|:------------------------------------|:--------------------------------------------------|
| vset /viewmode [viewmode_name] | Set ViewMode to (lit, normal, depth, object_mask) |
Expand Down
2 changes: 2 additions & 0 deletions docs/plugin/create.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
The advantage of plugin mode is the ability of creating new objects and design the scene with UE4 editor.

# Place multiple cameras
6 changes: 3 additions & 3 deletions docs/plugin/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,16 @@ git clone https://github.com/unrealcv/playground.git
---
## Code Documentation

The C++ source code of the plugin is documented with doxygen.

You can generate the document for code by running `cd docs/doxygen; doxygen`.
The C++ source code of the plugin is documented with doxygen. You can generate the document for code by running `cd docs/doxygen; doxygen`. An online version is hosted [here](https://codedocs.xyz/unrealcv/unrealcv/).

---
## UnrealCV Architecture

The initialization procedure of UnrealCV. The module loaded and start a TCP server waiting for connection. Commands will be parsed by regexp.

---
The code is here {{ config.extra.codebase }}

## Project Layout
client/ # Client code for Python and MATLAB
examples/ # Examples showing how to use client code to do tasks
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ pages:
- "UnrealCV commands": reference/command.md
# - "Video": reference/video.md
# - FAQ: faq.md
extra:
codebase: https://github.com/unrealcv/unrealcv

0 comments on commit 8b668a4

Please sign in to comment.