Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sankar Natarajan committed Aug 12, 2024
1 parent 6ea2503 commit 4b16a91
Showing 1 changed file with 1 addition and 29 deletions.
30 changes: 1 addition & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,32 +19,4 @@ on how to install Rock.
However, if you feel that it's too heavy for your needs, Rock aims at having
most of its "library" packages (such as this one) to follow best practices. See
[this page](http://rock-robotics.org/stable/documentation/packages/outside_of_rock.html)
for installation instructions outside of Rock.

Rock CMake Macros
-----------------

This package uses a set of CMake helper shipped as the Rock CMake macros.
Documentations is available on [this page](http://rock-robotics.org/stable/documentation/packages/cmake_macros.html).

Rock Standard Layout
--------------------

This directory structure follows some simple rules, to allow for generic build
processes and simplify reuse of this project. Following these rules ensures that
the Rock CMake macros automatically handle the project's build process and
install setup properly.

### Folder Structure

| directory | purpose |
| ----------------- | ------------------------------------------------------ |
| src/ | Contains all header (*.h/*.hpp) and source files |
| build/ * | The target directory for the build process, temporary content |
| bindings/ | Language bindings for this package, e.g. put into subfolders such as |
| ruby/ | Ruby language bindings |
| viz/ | Source files for a vizkit plugin / widget related to this library |
| resources/ | General resources such as images that are needed by the program |
| configuration/ | Configuration files for running the program |
| external/ | When including software that needs a non standard installation process, or one that can be easily embedded include the external software directly here |
| doc/ | should contain the existing doxygen file: doxygen.conf |
for installation instructions outside of Rock.

0 comments on commit 4b16a91

Please sign in to comment.