Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d5ae56f

Browse files
author
Davide Faconti
committed
adding summary page to docs
1 parent dd98ecc commit d5ae56f

File tree

2 files changed

+71
-6
lines changed

2 files changed

+71
-6
lines changed

docs/tutotials_summary.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Summary of the tutorials
2+
3+
## Tutorial 1: Create your first Behavior Tree
4+
5+
This tutorial demonstrates how to create custom `ActionNodes` in __C++__ and
6+
how to compose them into Trees using the __XML__ language.
7+
8+
## Tutorial 2: Parametrize a Node with Ports
9+
10+
TreeNodes can have both Inputs and Outputs Ports.
11+
This tutorial demonstrates how to use ports to create parametrized Nodes.
12+
13+
14+
## Tutorial 3: Generic and type-safe Ports
15+
16+
This tutorial is an extension of the previous one.
17+
18+
It shows how to create and use ports with generic and user-defined
19+
types.
20+
21+
## Tutorial 4: Difference between Sequence and ReactiveSequence
22+
23+
Reactive ControlNodes can be a very powerful tool to create sophisticated
24+
behaviors.
25+
26+
This example shows the difference between a standard Sequence and a Reactive one.
27+
28+
## Tutorial 5: How to reuse entire SubTrees
29+
30+
Reusability and Composability can be done at the level of a single Node,
31+
but also with entire Trees, which can become SubTrees of a "parent" Tree.
32+
33+
In this tutorial we will also introduce the builtin Loggers.
34+
35+
## Tutorial 6: Remapping of Ports between SubTrees and their parents
36+
37+
Any Tree/SubTree in the system has its own isolated BlackBoard.
38+
39+
In this tutorial we extend the concept or Ports to SubTrees, using
40+
port remapping.
41+
42+
## Tutorial 7: How to wrap legacy code in a non intrusive way
43+
44+
This tutorial shows one of the many possible ways to wrap an existing code
45+
into the `BehavioTree.CPP` infrastructure.
46+
47+
## Tutorial 8: Parametrization without Ports
48+
49+
If your custom Node has a lot of ports, it is probably a sign that you didn't
50+
understand the problem that Ports are supposed to solve ;)
51+
52+
In this tutorial, we show how to pass arguments to a custom Node class without
53+
polluting your interfaces with pointless Input Ports.
54+
55+
## Tutorial 9: Asynchronous actions with Coroutines
56+
57+
Coroutines are a powerful tool to create asynchronous code.
58+
59+
In this tutorial, we outline the typical design pattern to use when you
60+
implement an asynchronous Action using `CoroActionNode`.
61+
62+
63+
64+

mkdocs.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,16 @@ pages:
3232
- Home: index.md
3333

3434
- Learn the basics:
35-
- Introduction: BT_basics.md
36-
- Getting started: getting_started.md
37-
- Sequence Nodes: SequenceNode.md
38-
- Fallback Nodes: FallbackNode.md
39-
- Decorators Nodes: DecoratorNode.md
40-
- The XML format: xml_format.md
35+
- Introduction to BT: BT_basics.md
36+
- Getting started: getting_started.md
37+
- Sequence Nodes: SequenceNode.md
38+
- Fallback Nodes: FallbackNode.md
39+
- Decorators Nodes: DecoratorNode.md
40+
- The XML format: xml_format.md
4141

4242
- Tutorials:
4343

44+
- "Summary": tutorials_summary.md
4445
- "Tutorial 1: Create a Tree": tutorial_01_first_tree.md
4546
- "Tutorial 2: Basic Ports": tutorial_02_basic_ports.md
4647
- "Tutorial 3: Generic ports": tutorial_03_generic_ports.md

0 commit comments

Comments
 (0)