Create README.md

ijnek · Jun 18, 2021 · 6e6de48 · 6e6de48
1 parent 3a8a41b
commit 6e6de48
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# Nao Interfaces Docs
+
+Repository for maintaining the Sphinx Documentation for the ROS2 Nao Interfaces package.
+
+## Installing Dependencies
+`sudo apt install python3-sphinx-rtd-theme`
+
+## Compiling
+To compile locally, run `make html` in the root directory. 
+The home documentation page can be opened by opening `_build/html/index.html` in a browser.