Skip to content

Commit

Permalink
Add file structure
Browse files Browse the repository at this point in the history
  • Loading branch information
andyblarblar committed Oct 2, 2023
1 parent 864cd1d commit 5c8b7fc
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,26 @@ These are marked with TODO_EXTRA.
- ROS-Industrial github CI (will test units and lints)
- C++ formatting via clangformat
- A selection of sane lints
- A single node setup in a multithreaded executor
- A single node setup in a multithreaded executor

# File structure

```
.
├── include
│   └── TODO_PACKAGE_NAME
│   └── TODO_NODE_NAME_node.hpp
├── package.xml
├── README.md
├── src
│   ├── TODO_NODE_NAME.cpp
│   └── TODO_NODE_NAME_node.cpp
└── tests
└── unit.cpp
```

TODO_NODE_NAME_node: Source files for the ROS2 node object itself, and only itself

TODO_NODE_NAME.cpp: Source for the main function of the node, and only the main function

tests/unit.cpp: Example file for unit tests. This is linked to the node and ros, so both can be used

0 comments on commit 5c8b7fc

Please sign in to comment.