Skip to content

Commit

Permalink
Added CHANGELOG fiel, updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Alberto Pretto committed Apr 27, 2015
1 parent 863607b commit 8ff3ba3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
cROS 0.9
--------
* First public release
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ $ cmake ..
$ make
```

You will find a static library (libcros.a) inside the build/lib directory, and
You will find a static library (*libcros.a*) inside the *build/lib* directory, and
some test executables that makes use of the libcros library inside the
build/bin directory.
*build/bin* directory. The entrypoint sample to learn how to use cROS is
*samples/ros_api.c*, which shows a non trivial example of a ROS node with
publishers/subcribers and calls to ROS services.

If you want to build the create the library documentation, type: (you'll need
Doxygen)
Expand All @@ -35,6 +37,10 @@ Doxygen)
$ make docs
```

You'll find the html documentation inside the docs/html directory. To browse
You'll find the html documentation inside the *docs/html* directory. To browse
the documentation, open with a web browser the index.html file.

### Licensing

cROS is licensed under the GNU Lesser General Public License v3.0. For more
licensing options and for paid support please write an email to [email protected].

0 comments on commit 8ff3ba3

Please sign in to comment.