From 5c8b7fcecb89d82d23f576685dc1d6d1b8200c6c Mon Sep 17 00:00:00 2001
From: Andrew Ealovega <Andrew@Ealovega.dev>
Date: Sun, 1 Oct 2023 20:24:25 -0400
Subject: [PATCH] Add file structure

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2c9124d..3369c0a 100644
--- a/README.md
+++ b/README.md
@@ -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
\ No newline at end of file
+- 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
\ No newline at end of file