From a1e8443c417249dc6ff9a24c7c9d8fb2fce07c88 Mon Sep 17 00:00:00 2001 From: Matthias Andreas Benkard Date: Tue, 5 Dec 2023 21:12:16 +0100 Subject: jgvariant-tool: New module. Adds a command line tool that can read and (in the future) manipulate GVariant-formatted files. Change-Id: Icc92eb409a97e7cf72dfd7535f6a8b3587dd4a48 --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d01d141..caa9938 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,31 @@ pairs of [String][] and `int`, you can use the following code: List example = decoder.decode(ByteBuffer.wrap(bytes)); -## Installation +## Command line tool + +The `jgvariant-tool` module contains a tool called `jgvariant` that can +be used to manipulate [GVariant][]-formatted files from the command line. +Its primary purpose is to enable the scripting of [OSTree][] repository +management tasks. + +Usage example (dumping the contents of an [OSTree][] summary file): + + $ jgvariant ostree summary read ./jgvariant-ostree/src/test/resources/ostree/summary + +You can build the tool either as a shaded JAR or as a native executable. + +To build and run a shaded JAR: + + $ mvn package -pl jgvariant-tool -am -Pshade + $ java -jar /home/mulk/Arbeitskasten/jgvariant/jgvariant-tool/target/jgvariant-tool-*.jar + +To build and run a native executable: + + $ mvn package -pl jgvariant-tool -am -Pnative + $ ./jgvariant-tool/target/jgvariant + + +## Library installation ### Usage with Maven -- cgit v1.2.3