From f811b7b53c0c2f0d4320c70230e609619c5087c1 Mon Sep 17 00:00:00 2001 From: David Wagner Date: Thu, 6 Mar 2014 14:58:29 +0100 Subject: More README files - More details in the root README.md file; add a nice diagram - Add a lot of README files in subdirectories Signed-off-by: David Wagner --- test/test-platform/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 test/test-platform/README.md (limited to 'test') diff --git a/test/test-platform/README.md b/test/test-platform/README.md new file mode 100644 index 0000000..4e3cab8 --- /dev/null +++ b/test/test-platform/README.md @@ -0,0 +1,33 @@ +# test-platform + +Test-platform is a little executable that can instantiate a parameter-framework +with custom criteria and full control over criteria states. It also serves +as an example of a parameter-framework client. + +It offers the possibility to : + +- Give the parameter-framework configuration xml +- Create criteria from a name, a type (exclusive or inclusive), states (the + state number or a state name list) +- Start a parameter-framework instance +- Change criteria states and apply configurations + +## Usage + +Start it with: + + test-platform [-d] [port, defaults to 5001] + +(The optional `-d` option daemonizes test-platform). + +Then, you may send commands to the test-platform using remote-process; e.g: + + remote-process localhost 5001 help + remote-process localhost 5001 start + +## Known issues + +- The path to the configuration file must contain at least a `/`. Thus, if you +want to refer to a file in the current directory, you should write: + + test-platform ./ParameterFrameworkConfiguration.xml -- cgit v1.1