Skip to content

Commit

Permalink
update README.md for newer design
Browse files Browse the repository at this point in the history
  • Loading branch information
k-okada committed Dec 3, 2015
1 parent 0ed8937 commit 5d1c539
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,14 @@ jsk_docs [![Documentation Status](https://readthedocs.org/projects/jsk-docs/badg
========

# how to add repository
```
cd doc
git submodule add http://github.com/jsk-ros-pkg/jsk_xxx jsk_xxx
```
and add that information to doc/index.rst

# how to update repository
add repository to the `doc/doc.rosinstall` file, the format follows [rosinstall format](http://docs.ros.org/independent/api/rosinstall/html/rosinstall_file_format.html)

# how to generate doc on local environment
```
cd doc
update_submodule.sh
git commit -m "update submodules for repository `LC_TIME=C date`" -a
source ./setup.sh
make html
make doc
```

# how to update doc directory
```
cd doc/jsk_xxx
../update_doc_link.sh
```

0 comments on commit 5d1c539

Please sign in to comment.