Docs: Cyber documents and corresponding images

ApolloAuto · Jan 7, 2019 · 6c6954a · 6c6954a
1 parent 9de8d16
commit 6c6954a
Show file tree

Hide file tree

Showing 10 changed files with 41 additions and 25 deletions.
diff --git a/cyber/README.md b/cyber/README.md
@@ -1,8 +1,8 @@
 # Introduction
 
-Apollo Cyber is an open source high performance runtime framework designed specifically for autonomous driving scenarios. Based on centralized computing model, it is highly optimized for high concurrency, low latency, and high throughput in autonomous driving.
+Apollo Cyber RT is an open source, high performance runtime framework designed specifically for autonomous driving scenarios. Based on a centralized computing model, it is greatly optimized for high concurrency, low latency, and high throughput in autonomous driving.
 
-During years of development of autonomous driving technologies, we have learned a lot from our previous experience with Apollo. The industry is evolving, so does Apollo. Going forward, Apollo has already moved from development to productization, with volume deployments in the real world, we see the demands for the highest robustness and high performance. That’s why we spent years of building Apollo Cyber RT, which addresses that requirements of autonomous driving solutions. 
+During the last few years of the development of autonomous driving technologies, we have learned a lot from our previous experience with Apollo. The industry is evolving and so is Apollo. Going forward, Apollo has already moved from development to productization, with volume deployments in the real world, we see the demands for the highest level of robustness and performance. That’s why we spent years building and perfecting Apollo Cyber RT, which addresses that requirements of autonomous driving solutions. 
 
 Key benefits of using Apollo Cyber RT:
 
@@ -19,14 +19,14 @@ Key benefits of using Apollo Cyber RT:
   + Building blocks specifically designed for autonomous driving
   + Plug and play your own AD system
 
-# Documents
-
-* [Apollo Cyber RT Quick Start](https://github.com/ApolloAuto/apollo/tree/master/docs/cyber/CyberRT_Quick_Start.md): Everything you need to know about how to start developing your first application module on top of Apollo Cyber RT. 
-
-* [Apollo Cyber RT Developer Tools](https://github.com/ApolloAuto/apollo/tree/master/docs/cyber/CyberRT_Developer_Tools.md): Detailed guidance on how to use the developer tools from Apollo Cyber RT. 
-
-* [Apollo Cyber RT API for Developers](https://github.com/ApolloAuto/apollo/tree/master/docs/cyber/CyberRT_API_for_Developers.md): A comprehensive guide to explore all the APIs of Apollo Cyber RT, with many concrete examples in source code.
-
-* [Apollo Cyber RT FAQs](https://github.com/ApolloAuto/apollo/tree/master/docs/cyber/CyberRT_FAQs.md): Answers to the most frequently asked questions about Apollo Cyber RT.
-
-More documents to come soon!
+# Documents
+
+* [Apollo Cyber RT Quick Start](https://github.com/ApolloAuto/apollo/tree/master/docs/specs/cyber/CyberRT_Quick_Start.md): Everything you need to know about how to start developing your first application module on top of Apollo Cyber RT. 
+
+* [Apollo Cyber RT Developer Tools](https://github.com/ApolloAuto/apollo/tree/master/docs/specs/cyber/CyberRT_Developer_Tools.md): Detailed guidance on how to use the developer tools from Apollo Cyber RT. 
+
+* [Apollo Cyber RT API for Developers](https://github.com/ApolloAuto/apollo/tree/master/docs/specs/cyber/CyberRT_API_for_Developers.md): A comprehensive guide to explore all the APIs of Apollo Cyber RT, with many concrete examples in source code.
+
+* [Apollo Cyber RT FAQs](https://github.com/ApolloAuto/apollo/tree/master/docs/FAQs/cyber/CyberRT_FAQs.md): Answers to the most frequently asked questions about Apollo Cyber RT.
+
+More documents to come soon!
diff --git a/docs/cyber/CyberRT_FAQs.md → docs/FAQs/CyberRT_FAQs.md b/docs/cyber/CyberRT_FAQs.md → docs/FAQs/CyberRT_FAQs.md
@@ -58,3 +58,4 @@ If you have not modified anything at runtime framework layer and have only worke
 - Fork and clone the Apollo repo with the new framework code which can be found at [apollo/cyber](https://github.com/ApolloAuto/apollo/tree/master/cyber/)
 
 ---
+More FAQs to follow...
diff --git a/docs/specs/cyber/.DS_Store b/docs/specs/cyber/.DS_Store
diff --git a/docs/cyber/CyberRT_Developer_Tools.md → docs/specs/cyber/CyberRT_Developer_Tools.md b/docs/cyber/CyberRT_Developer_Tools.md → docs/specs/cyber/CyberRT_Developer_Tools.md
@@ -36,7 +36,7 @@ username@computername:~$: cyber_visualizer
 As for a point cloud or an image, you can select the source channel through its `ChannelName` sub-item, and `Action` sub-item to play or stop the data from the corresponding channel.
 As shown in figure below, three cameras' channel data on the buttom sections and one point cloud channel data on the top section are displayed simultaneously.
 
-	![visualization](images/cyber_visualizer3.png)
+    ![visualization](images/cyber_visualizer3.png)
 
 - To adjust the virtual camera in the 3D point cloud scene, you can right click on the point cloud display section. A dialog box will pop up as shown in figure below.
 

diff --git a/docs/cyber/CyberRT_Quick_Start.md → docs/specs/cyber/CyberRT_Quick_Start.md b/docs/cyber/CyberRT_Quick_Start.md → docs/specs/cyber/CyberRT_Quick_Start.md
@@ -18,9 +18,9 @@ The example below demonstrates how to create a simple component, then build, run
 ## Set up the component file structure
 Please create the following files, assumed under the directory of `/apollo/cyber/examples/common_component_example/`:
 
-- header file: common_component_example.h
-- source file: common_component_example.cc
-- build file: BUILD
+- Header file: common_component_example.h
+- Source file: common_component_example.cc
+- Build file: BUILD
 - DAG dependency file: common.dag
 - Launch file: common.launch
 
@@ -114,9 +114,9 @@ cpplint()
 
 To configure the DAG dependency file (common.dag), specify the following items as below:
 
- - channel names: for data input and output
- - library path: library built from component class
- - class name: the class name of the component
+ - Channel names: for data input and output
+ - Library path: library built from component class
+ - Class name: the class name of the component
 
 ```bash
 # Define all coms in DAG streaming.
@@ -141,9 +141,9 @@ To configure the DAG dependency file (common.dag), specify the following items a
 
 To configure the launch (common.launch) file, specify the following items:
 
-  - the name of the component
-  - the dag file you just created in the previous step.
-  - the name of the process which the component runs within
+  - The name of the component
+  - The dag file you just created in the previous step.
+  - The name of the process which the component runs within
 
 ```bash
 <cyber>
@@ -174,13 +174,13 @@ source setup.bash
 
 There are two ways to launch the component:
 
-- launch with the launch file (recommended)
+- Launch with the launch file (recommended)
 
 ```bash
 cyber_launch start /apollo/cyber/examples/common_component_example/common.launch
 ```
 
-- launch with the DAG file
+- Launch with the DAG file
 
 ```bash
 mainboard -d /apollo/cyber/examples/common_component_example/common.dag

diff --git a/docs/specs/cyber/images/cyber_monitor.png b/docs/specs/cyber/images/cyber_monitor.png
diff --git a/docs/specs/cyber/images/cyber_visualizer1.png b/docs/specs/cyber/images/cyber_visualizer1.png
diff --git a/docs/specs/cyber/images/cyber_visualizer2.png b/docs/specs/cyber/images/cyber_visualizer2.png
diff --git a/docs/specs/cyber/images/cyber_visualizer3.png b/docs/specs/cyber/images/cyber_visualizer3.png
diff --git a/docs/specs/cyber/images/cyber_visualizer4.png b/docs/specs/cyber/images/cyber_visualizer4.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -58,3 +58,4 @@ If you have not modified anything at runtime framework layer and have only worke
		- Fork and clone the Apollo repo with the new framework code which can be found at [apollo/cyber](https://github.com/ApolloAuto/apollo/tree/master/cyber/)

		---
		More FAQs to follow...