Move documentation instructions in root README, delete how to contrib…

…ute instructions
ros-industrial-attic · Feb 14, 2019 · de79b5b · de79b5b
1 parent ca63628
commit de79b5b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -77,13 +77,21 @@ catkin build
 ```
 
 # Documentation
-Please read [doc/README.md](doc/README.md).
+## API documentation
+
+Install rosdoc_lite:
+```
+sudo apt install ros-$ROS_DISTRO-rosdoc-lite
+```
+
+Generate the API documentation:
+```bash
+catkin_make bezier_doc
+```
+
+## Documented classes of Bezier
+- [bezier_grinding_surfacing](README_bezier_grinding_surfacing.md)
 
 # Example packages using `bezier`
 - [bezier_examples](https://github.com/ros-industrial-consortium/bezier_examples)
 - [fanuc_grinding](https://gitlab.com/InstitutMaupertuis/fanuc_grinding)
-
-# How to contribute
-- [Report issues](https://github.com/ros-industrial-consortium/bezier/issues)
-- Write documentation
-- Open [merge request](https://github.com/ros-industrial-consortium/bezier/pulls/) to fix bugs, improve/add functionalities
diff --git a/doc/README.md b/doc/README.md