Update documentation

  remove obsolete files,
  add installation instructions

README

 #
-#  Copyright 2007 LAAS-CNRS
-#
-
-This package implements a documentation of most HPP software packages. 
-It includes:
-  -1. information about how to install HPP software,
-  -2. information about how to develop in HPP
-  -3. a front page with links to the packages constituting HPP.
+#  Copyright 2014 LAAS-CNRS
+#  Author: Florent Lamiraux
 
-Item 3 implies that this documentation depends on all the documented packages.
-To make possible the installation of this documentation without primarily
-installing all the necessary packages, all the dependencies have been 
-made optional in the configure.ac file:
+Humanoid Path Planner is a software platform aimed at solving motion planning
+problems for humanoid robots. It is also designed to solve classical (non
+humanoid) path planning problems.
 
-It is recommended to do the following operations:
-  1. install documentation as such (see INSTALL)
-  2. install HPP packages you need (Related Pages->How to install HPP)
-  4. reinstall the documentation: (configure, make install).
+Installation
+============
 
+To install all the packages under ubuntu 12.04 LTS, you should do the following
+steps:
 
+  1. install through apt-get
+    - ros-groovy-desktop-full,
+    - ros-groovy-libccd,
+    - ascii-doc,
+    - source-highlight
 
+  2. Choose a directory on you file system and define the environment
+     variable DEVEL_DIR with the full path to this directory.
+     - the packages will be cloned into $DEVEL_DIR/src,
+     - the packages will be installed in $DEVEL_DIR/install
 
+  3. Copy
+   - https://raw.githubusercontent.com/humanoid-path-planner/hpp-doc/master/doc/config.sh in $DEVEL_DIR, and
+   -https://raw.githubusercontent.com/humanoid-path-planner/hpp-doc/master/doc/Makefile in $DEVEL_DIR/src 
+  
+  4. cd into $DEVEL_DIR/src and type
 
+    make all.
 

doc/Makefile

+#
+# Copyright (c) 2014 CNRS-LAAS
+# Author: Florent Lamiraux
+#
+
+FCL_REPO=https://github.com/flexible-collision-library
+JRL_REPO=https://github.com/jrl-umi3218
+LAAS_REPO=https://github.com/laas
+HPP_REPO=https://github.com/humanoid-path-planner
+
+SRC_DIR=${DEVEL_DIR}/src
+BUILD_TYPE=Debug
+
+fcl_branch=master
+fcl_repository=${FCL_REPO}
+
+jrl-mathtools_branch=master
+jrl-mathtools_repository=${JRL_REPO}
+
+hpp-util_branch=master
+hpp-util_repository=${HPP_REPO}
+
+roboptim-core_branch=master
+roboptim-core_repository=https://github.com/roboptim
+
+roboptim-trajectory_branch=master
+roboptim-trajectory_repository=https://github.com/roboptim
+
+hpp-model_branch=master
+hpp-model_repository=${HPP_REPO}
+
+hpp-model-urdf_branch=master
+hpp-model-urdf_repository=${HPP_REPO}
+
+hpp-core_branch=master
+hpp-core_repository=${HPP_REPO}
+
+hpp-template-corba_branch=master
+hpp-template-corba_repository=${LAAS_REPO}
+
+hpp-corbaserver_branch=master
+hpp-corbaserver_repository=${HPP_REPO}
+
+hpp-constraints_branch=master
+hpp-constraints_repository=${HPP_REPO}
+
+hpp-wholebody-step_branch=master
+hpp-wholebody-step_repository=${HPP_REPO}
+
+hpp-wholebody-step-corba_branch=master
+hpp-wholebody-step-corba_repository=${HPP_REPO}
+
+hpp_ros_branch=master
+hpp_ros_repository=${HPP_REPO}
+
+test-hpp_branch=master
+test-hpp_repository=${HPP_REPO}
+
+hrp2_branch=groovy
+hrp2_repository=${FLORENT_REPO}
+
+robot_capsule_urdf_branch=groovy
+robot_capsule_urdf_repository=${LAAS_REPO}
+
+robot_model_py_branch=groovy
+robot_model_py_repository=${LAAS_REPO}
+
+hpp-doc_branch=master
+hpp-doc_repository=${HPP_REPO}
+
+packages= \
+	fcl \
+	jrl-mathtools \
+	hpp-util \
+	roboptim-core \
+	roboptim-trajectory \
+	hpp-model \
+	hpp-model-urdf \
+	hpp-core \
+	hpp-template-corba \
+	hpp-corbaserver \
+	hpp-constraints \
+	hpp-wholebody-step \
+	hpp-wholebody-step-corba \
+	hpp_ros \
+	test-hpp \
+	hpp-doc
+
+install_all=$(packages:=.all)
+
+all: ${install_all}
+
+%.all: %.checkout %.configure %.install
+	@echo "\n ***********************************************************\n" \
+	"*** finished installing $(@:.all=)\n" \
+	"************************************************************\n"
+
+%.checkout:
+	if [ -d $(@:.checkout=) ]; then \
+		echo "$(@:.checkout=) already checkout out." \
+	else \
+		git clone --recursive -b ${$(@:.checkout=)_branch} ${$(@:.checkout=)_repository}/$(@:.checkout=); \
+	fi \
+
+%.update:
+	cd ${SRC_DIR}/$(@:.update=);\
+	git remote set-url origin ${$(@:.update=)_repository}/$(@:.update=);\
+	git fetch origin;\
+	git checkout -b bce46g origin/${$(@:.update=)_branch};\
+	git branch -D ${$(@:.update=)_branch};\
+	git checkout -b ${$(@:.update=)_branch} bce46g;\
+	git branch -D bce46g;\
+	git submodule update
+
+%.configure:
+	cd ${SRC_DIR}/$(@:.configure=);\
+	mkdir -p build; \
+	cd ${SRC_DIR}/$(@:.configure=)/build; \
+	cmake -DCMAKE_INSTALL_PREFIX=${DEVEL_DIR}/install -DCMAKE_INSTALL_LIBDIR=lib -DCMAKE_BUILD_TYPE=${BUILD_TYPE} ..
+
+%.install:
+	cd ${SRC_DIR}/$(@:.install=)/build;\
+	make install
+
+%.uninstall:
+	cd ${SRC_DIR}/$(@:.uninstall=)/build;\
+	make uninstall
+
+%.clean:
+	cd ${SRC_DIR}/$(@:.clean=)/build;\
+	make clean
+
+%.status:
+	cd ${SRC_DIR}/$(@:.status=); git status
+
+hpp-doc.configure:
+	cd ${SRC_DIR}/$(@:.configure=);\
+	./bootstrap;\
+	mkdir -p build; \
+	cd ${SRC_DIR}/$(@:.configure=)/build; \
+	../configure --prefix=${DEVEL_DIR}/install
+
+eigen3.checkout:
+	wget -O eigen3.tar.bz2 http://bitbucket.org/eigen/eigen/get/3.2.1.tar.bz2;\
+	cd ${SRC_DIR}; bunzip2 eigen3.tar.bz2; tar xvf eigen3.tar;\
+	rm -f eigen3.tar; mv eigen-eigen-6b38706d90a9 eigen3
+
+hrp2.configure:
+	cd ${SRC_DIR}/hrp2/hrp2_14_description;\
+	mkdir -p build; \
+	cd ${SRC_DIR}/hrp2/hrp2_14_description/build; \
+	cmake -DCMAKE_INSTALL_PREFIX=${DEVEL_DIR}/install -DCMAKE_INSTALL_LIBDIR=lib -DCMAKE_BUILD_TYPE=${BUILD_TYPE} ..
+
+hrp2.install:
+	cd ${SRC_DIR}/hrp2/hrp2_14_description/build;\
+	make install
+
+robot_model_py.configure:
+	cd ${SRC_DIR}/$(@:.configure=)/xml_reflection;\
+	mkdir -p build; \
+	cd build; \
+	cmake -DCMAKE_INSTALL_PREFIX=${DEVEL_DIR}/install -DCMAKE_INSTALL_LIBDIR=lib -DCMAKE_BUILD_TYPE=${BUILD_TYPE} ..
+	cd ${SRC_DIR}/$(@:.configure=)/urdf_parser_py;\
+	mkdir -p build; \
+	cd build; \
+	cmake -DCMAKE_INSTALL_PREFIX=${DEVEL_DIR}/install -DCMAKE_INSTALL_LIBDIR=lib -DCMAKE_BUILD_TYPE=${BUILD_TYPE} ..

doc/Makefile.am

@@ -47,8 +47,6 @@ DOC_EXTRA =				\
 	doxygen.css			\
 	figures/archi.png		\
 	figures/kppInterfaceWalk.png	\
-	movies/passing-under.mp4	\
-	movies/whole-body.mp4		\
 	images/dependencies.png		\
 	images/film.png			\
 	images/footer.jpg		\

doc/config.sh

+export PATH=$DEVEL_DIR/install/sbin:$DEVEL_DIR/install/bin:$PATH
+export PKG_CONFIG_PATH=$DEVEL_DIR/install/lib/pkgconfig/:/opt/grx/lib/pkgconfig
+
+export PYTHONPATH=$DEVEL_DIR/install/lib/python2.7/site-packages:$DEVEL_DIR/install/lib/python2.7/dist-packages:/opt/ros/groovy/lib/python2.7/dist-packages:$PYTHONPATH
+
+export LD_LIBRARY_PATH=$DEVEL_DIR/install/lib:/opt/ros/groovy/lib:$LD_LIBRARY_PATH
+
+if [ -f $DEVEL_DIR/install/setup.bash ]; then
+    source $DEVEL_DIR/install/setup.bash
+endif