diff --git a/SMACC2 Run Time Analyzer/index.rst b/SMACC2 Run Time Analyzer/index.rst new file mode 100644 index 0000000..2f830e0 --- /dev/null +++ b/SMACC2 Run Time Analyzer/index.rst @@ -0,0 +1,15 @@ +.. _about: + +About and Contact +################# + + +About +***** +SMACC is an event-driven, asynchronous, behavioral state machine library for ROS2 (Robotic Operating System) applications written in C++. + +Contact +******* +If you are interested in contacting someone about SMACC2, or related projects, please email brett@robosoft.ai. + +If your inquiry relates to bugs or open-source feature requests, consider posting a ticket at [https://github.com/robosoft-ai/SMACC2](https://github.com/robosoft-ai/SMACC2). diff --git a/about - Copy/index.rst b/about - Copy/index.rst new file mode 100644 index 0000000..2f830e0 --- /dev/null +++ b/about - Copy/index.rst @@ -0,0 +1,15 @@ +.. _about: + +About and Contact +################# + + +About +***** +SMACC is an event-driven, asynchronous, behavioral state machine library for ROS2 (Robotic Operating System) applications written in C++. + +Contact +******* +If you are interested in contacting someone about SMACC2, or related projects, please email brett@robosoft.ai. + +If your inquiry relates to bugs or open-source feature requests, consider posting a ticket at [https://github.com/robosoft-ai/SMACC2](https://github.com/robosoft-ai/SMACC2). diff --git a/cbl_tutorials/docs/simple_state_machine.rst b/cbl_tutorials/docs/simple_state_machine.rst new file mode 100644 index 0000000..8e9a3d5 --- /dev/null +++ b/cbl_tutorials/docs/simple_state_machine.rst @@ -0,0 +1,29 @@ +.. _simple_state_machine: + +Creating a simple state machine +******************************* + +- `Overview`_ +- `Requirements`_ +- `Tutorial Steps`_ + +Overview +======== + +This tutorial shows how to create a simple state machine. +Before completing this tutorials, completing :ref:`getting_started` is highly recommended especially if you are new to ROS and SMACC2. + +Requirements +============ + +You must install SMACC2. +If you don't have them installed, please follow :ref:`getting_started`. + +Tutorial Steps +============== + +0- step 0 +-------------------------------------------- + +1- step 1 +------------------------------- \ No newline at end of file diff --git a/cbl_tutorials/index.rst b/cbl_tutorials/index.rst new file mode 100644 index 0000000..29294bb --- /dev/null +++ b/cbl_tutorials/index.rst @@ -0,0 +1,12 @@ +.. _tutorials: + +General Tutorials +################# + +SMACC2 Tutorials + +.. toctree:: + :maxdepth: 1 + + docs/simple_state_machine.rst + diff --git a/finepoints/index.rst b/finepoints/index.rst new file mode 100644 index 0000000..34af5be --- /dev/null +++ b/finepoints/index.rst @@ -0,0 +1,20 @@ +.. _concepts: + +Finer Points +################### + +This page is to help familiarize new robotists to the concepts of state machines, in particular, with the concepts required to appreciating and working with this project. + +ROS 2 is the core middleware used for SMACC2. If you are unfamilar with this, please visit `the ROS 2 documentation `_ before continuing. + +States +============= + +Clients +======================== + +Client Behaviors +======================== + +Orthogonals +======================== \ No newline at end of file diff --git a/mechanisms/index.rst b/mechanisms/index.rst new file mode 100644 index 0000000..6c8c1cd --- /dev/null +++ b/mechanisms/index.rst @@ -0,0 +1,20 @@ +.. _concepts: + +SMACC2 Mechanisms +################### + +This page is to help familiarize new robotists to the concepts of state machines, in particular, with the concepts required to appreciating and working with this project. + +ROS 2 is the core middleware used for SMACC2. If you are unfamilar with this, please visit `the ROS 2 documentation `_ before continuing. + +States +============= + +Clients +======================== + +Client Behaviors +======================== + +Orthogonals +======================== \ No newline at end of file