Revision: 6438
http://playerstage.svn.sourceforge.net/playerstage/?rev=6438&view=rev
Author: gbiggs
Date: 2008-05-14 19:09:05 -0700 (Wed, 14 May 2008)
Log Message:
-----------
Updated and added README files for all examples
Modified Paths:
--------------
code/player/trunk/examples/libplayerc/CMakeLists.txt
code/player/trunk/examples/libplayerc++/CMakeLists.txt
code/player/trunk/examples/plugins/exampledriver/README
code/player/trunk/examples/plugins/exampleinterface/README
code/player/trunk/examples/plugins/multidriver/README
Added Paths:
-----------
code/player/trunk/examples/libplayerc/README
code/player/trunk/examples/libplayerc++/README
code/player/trunk/examples/plugins/opaquedriver/README
Modified: code/player/trunk/examples/libplayerc/CMakeLists.txt
===================================================================
--- code/player/trunk/examples/libplayerc/CMakeLists.txt 2008-05-14
23:28:50 UTC (rev 6437)
+++ code/player/trunk/examples/libplayerc/CMakeLists.txt 2008-05-15
02:09:05 UTC (rev 6438)
@@ -19,5 +19,5 @@
SET (exampleCMakeLists ${CMAKE_CURRENT_BINARY_DIR}/CMakeLists.txt.example)
CONFIGURE_FILE (${exampleCMakeLists_in} ${exampleCMakeLists} @ONLY)
INSTALL (FILES ${exampleCMakeLists} DESTINATION
share/${PROJECT_NAME_LOWER}/examples/libplayerc RENAME CMakeLists.txt)
-SET (exampleSrcs vmap.c simple.c speech_c_client.c service_discovery.c)
+SET (exampleSrcs vmap.c simple.c speech_c_client.c service_discovery.c README)
INSTALL (FILES ${exampleSrcs} DESTINATION
share/${PROJECT_NAME_LOWER}/examples/libplayerc)
Added: code/player/trunk/examples/libplayerc/README
===================================================================
--- code/player/trunk/examples/libplayerc/README
(rev 0)
+++ code/player/trunk/examples/libplayerc/README 2008-05-15 02:09:05 UTC
(rev 6438)
@@ -0,0 +1,31 @@
+Building
+--------
+
+The examples can be built by making a directory (anywhere on your system where
+you have write permissions will do), changing to that directory and executing
+CMake with the examples' source directory as an argument. For example, if you
+have installed Player into /usr/local, you could do the following:
+
+$ cd ~
+$ mkdir libplayerc_example
+$ cd libplayerc_example
+$ ccmake /usr/local/share/player/examples/libplayerc
+
+Use the configure option (press 'c' in the Linux ncurses-based UI, for example)
+until the generate option becomes available, then use that (press 'g' in the
+ncurses UI). Then use the standard method of compiling for your environment to
+compile (on Linux, this will probably be GNU Makefiles, so type 'make').
+
+Running
+-------
+
+The examples each require that a Player server providing the necessary devices
+is running. These are:
+
+simple: position2d
+vmap: laser
+service_discovery: vectormap
+speed_c_client: speech
+
+For simple and vmap, the simple.cfg configuration sample provided with stage
+will suffice.
\ No newline at end of file
Modified: code/player/trunk/examples/libplayerc++/CMakeLists.txt
===================================================================
--- code/player/trunk/examples/libplayerc++/CMakeLists.txt 2008-05-14
23:28:50 UTC (rev 6437)
+++ code/player/trunk/examples/libplayerc++/CMakeLists.txt 2008-05-15
02:09:05 UTC (rev 6438)
@@ -48,6 +48,7 @@
SET (exampleCMakeLists ${CMAKE_CURRENT_BINARY_DIR}/CMakeLists.txt.example)
CONFIGURE_FILE (${exampleCMakeLists_in} ${exampleCMakeLists} @ONLY)
INSTALL (FILES ${exampleCMakeLists} DESTINATION
share/${PROJECT_NAME_LOWER}/examples/libplayerc++ RENAME CMakeLists.txt)
+ INSTALL (FILES README DESTINATION
share/${PROJECT_NAME_LOWER}/examples/libplayerc++)
ELSE (BUILD_PLAYERCC)
MESSAGE (STATUS "playerc++ examples will not be built - playerc++ client
library is disabled")
ENDIF (BUILD_PLAYERCC)
Added: code/player/trunk/examples/libplayerc++/README
===================================================================
--- code/player/trunk/examples/libplayerc++/README
(rev 0)
+++ code/player/trunk/examples/libplayerc++/README 2008-05-15 02:09:05 UTC
(rev 6438)
@@ -0,0 +1,45 @@
+Building
+--------
+
+The examples can be built by making a directory (anywhere on your system where
+you have write permissions will do), changing to that directory and executing
+CMake with the examples' source directory as an argument. For example, if you
+have installed Player into /usr/local, you could do the following:
+
+$ cd ~
+$ mkdir libplayerc++_example
+$ cd libplayerc++_example
+$ ccmake /usr/local/share/player/examples/libplayerc++
+
+Use the configure option (press 'c' in the Linux ncurses-based UI, for example)
+until the generate option becomes available, then use that (press 'g' in the
+ncurses UI). Then use the standard method of compiling for your environment to
+compile (on Linux, this will probably be GNU Makefiles, so type 'make').
+
+Running
+-------
+
+The examples each require that a Player server providing the necessary devices
+is running. These are:
+
+camera: camera
+clientgraphics: graphics2d
+clientgraphics3d: graphics3d
+example0: position2d, sonar
+example1: camera
+example2: camera
+example3: camera
+example4: ir, position2d
+goto: position2d, sonar
+grip: gripper
+laserobstacleavoid: laser, position2d
+ptz: camera, ptz
+randomwalk: laser or sonar, position2d
+sonarobstacleavoid: position2d, sonar
+speech: speech
+speech_cpp_client: speech
+wallfollow: laser, position2d
+
+For example0, goto, laserobstacleavoid, randomwalk, sonarobstacleavoid and
+wallfollow, the simple.cfg configuration sample provided with Stage will
+suffice.
\ No newline at end of file
Modified: code/player/trunk/examples/plugins/exampledriver/README
===================================================================
--- code/player/trunk/examples/plugins/exampledriver/README 2008-05-14
23:28:50 UTC (rev 6437)
+++ code/player/trunk/examples/plugins/exampledriver/README 2008-05-15
02:09:05 UTC (rev 6438)
@@ -1,14 +1,27 @@
-Here's a very simple example of how to write a driver and build it as a
-shared object. For details on how to handle configuration requests, get
-commands, push out data, etc., consult the User Manual.
+Building
+--------
-To build this example, edit the Makefile according to where you've got
-Player installed and then type 'make'.
+The example can be built by making a directory (anywhere on your system where
+you have write permissions will do), changing to that directory and executing
+CMake with the example's source directory as an argument. For example, if you
+have installed Player into /usr/local, you could do the following:
-To try it, run:
+$ cd ~
+$ mkdir exampledriver
+$ cd exampledriver
+$ ccmake /usr/local/share/player/examples/plugins/exampledriver/
- $ player example.cfg
+Use the configure option (press 'c' in the Linux ncurses-based UI, for example)
+until the generate option becomes available, then use that (press 'g' in the
+ncurses UI). Then use the standard method of compiling for your environment to
+compile (on Linux, this will probably be GNU Makefiles, so type 'make').
+Running
+-------
- brian gerkey
- [EMAIL PROTECTED]
+The example creates a shared library (libexampledriver.so on Unix-based
+systems), which is loaded by the server using the example.cfg configuration
+file. Copy this to the directory where you built the example and execute the
+Player server:
+
+$ player example.cfg
\ No newline at end of file
Modified: code/player/trunk/examples/plugins/exampleinterface/README
===================================================================
--- code/player/trunk/examples/plugins/exampleinterface/README 2008-05-14
23:28:50 UTC (rev 6437)
+++ code/player/trunk/examples/plugins/exampleinterface/README 2008-05-15
02:09:05 UTC (rev 6438)
@@ -1,12 +1,37 @@
-Here's a very simple example of how to write a plugin interface. This example
-uses several other aspects of player, including configuration files, a
-libplayerc client program and a plugin driver. For details on creating and
using
-these, see the User Manual.
+Building
+--------
-To build this example, edit the Makefile according to where you've got
-Player installed and then type 'make'.
+The example can be built by making a directory (anywhere on your system where
+you have write permissions will do), changing to that directory and executing
+CMake with the example's source directory as an argument. For example, if you
+have installed Player into /usr/local, you could do the following:
-To try it, run (in separate terminals):
+$ cd ~
+$ mkdir exampleinterface
+$ cd exampleinterface
+$ ccmake /usr/local/share/player/examples/plugins/exampleinterface/
- $ player example.cfg
- $ ./example_client
\ No newline at end of file
+Use the configure option (press 'c' in the Linux ncurses-based UI, for example)
+until the generate option becomes available, then use that (press 'g' in the
+ncurses UI). Then use the standard method of compiling for your environment to
+compile (on Linux, this will probably be GNU Makefiles, so type 'make').
+
+Running
+-------
+
+This example creates three objects: an interface plugin, a driver plugin for
+the new interface, and a client program that uses the new interface in
+conjunction with the plugin driver.
+
+The interface plugin and driver plugin are loaded by the example.cfg
+configuration file. Copy this to the directory where you built the example and
+execute Player:
+
+$ player example.cfg
+
+In a separate terminal, execute the client program:
+
+$ ./example_client
+
+You should see commands, data and requests moving between the client and the
+driver.
\ No newline at end of file
Modified: code/player/trunk/examples/plugins/multidriver/README
===================================================================
--- code/player/trunk/examples/plugins/multidriver/README 2008-05-14
23:28:50 UTC (rev 6437)
+++ code/player/trunk/examples/plugins/multidriver/README 2008-05-15
02:09:05 UTC (rev 6438)
@@ -1,15 +1,27 @@
+Building
+--------
-Here's a very simple example of how to write a driver that supports
-multiple interfaces (also builds as a loadable object). For details
-on how to handle configuration requests, get commands, push out data,
-etc., consult the User Manual.
+The example can be built by making a directory (anywhere on your system where
+you have write permissions will do), changing to that directory and executing
+CMake with the example's source directory as an argument. For example, if you
+have installed Player into /usr/local, you could do the following:
-To build this example, edit the Makefile according to where you've got
-the Player installed and then type 'make'.
+$ cd ~
+$ mkdir multidriver
+$ cd multidriver
+$ ccmake /usr/local/share/player/examples/plugins/multidriver/
-To try it, run:
+Use the configure option (press 'c' in the Linux ncurses-based UI, for example)
+until the generate option becomes available, then use that (press 'g' in the
+ncurses UI). Then use the standard method of compiling for your environment to
+compile (on Linux, this will probably be GNU Makefiles, so type 'make').
- $ player multi.cfg
+Running
+-------
- Andrew Howard
- [EMAIL PROTECTED]
+The example creates a shared library (libexampledriver.so on Unix-based
+systems), which is loaded by the server using the multi.cfg configuration file.
+Copy this to the directory where you built the example and execute the Player
+server:
+
+$ player multi.cfg
\ No newline at end of file
Added: code/player/trunk/examples/plugins/opaquedriver/README
===================================================================
--- code/player/trunk/examples/plugins/opaquedriver/README
(rev 0)
+++ code/player/trunk/examples/plugins/opaquedriver/README 2008-05-15
02:09:05 UTC (rev 6438)
@@ -0,0 +1,33 @@
+Building
+--------
+
+The example can be built by making a directory (anywhere on your system where
+you have write permissions will do), changing to that directory and executing
+CMake with the example's source directory as an argument. For example, if you
+have installed Player into /usr/local, you could do the following:
+
+$ cd ~
+$ mkdir opaque_example
+$ cd opaque_example
+$ ccmake /usr/local/share/player/examples/plugins/opaque_example/
+
+Use the configure option (press 'c' in the Linux ncurses-based UI, for example)
+until the generate option becomes available, then use that (press 'g' in the
+ncurses UI). Then use the standard method of compiling for your environment to
+compile (on Linux, this will probably be GNU Makefiles, so type 'make').
+
+Running
+-------
+
+This example creates a plugin driver shared library (libopaquedriver.so on
+Unix-based systems), which is loaded by the server using the opaque.cfg
+configuration file. Copy this to the directory where you built the example and
+execute the Player server:
+
+$ player opaque.cfg
+
+The example also creates a client to match the driver, called "opaque". This
+client will connect to the Player server, subscribe to the plugin driver and
+test the interface. Execute it in a separate terminal from the server:
+
+$ ./opaque
\ No newline at end of file
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Playerstage-commit mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/playerstage-commit
