package_tool: document the tools and the packager script

Author: pillo79

extra/package_tool.sh

@@ -2,16 +2,17 @@
 
 set -e
 
-TOOL_NAME=$(basename $1)
-VERSION=$2
+TOOL_DIR=$(readlink -f ${1:-.})
+TOOL_NAME=$(basename $TOOL_DIR)
+VERSION=${2:-dev}
 
-BASE_DIR=$(readlink -f $(dirname $0)/..)
-TOOL_DIR="$BASE_DIR/extra/$TOOL_NAME"
-if ! [ -d "$TOOL_DIR" ] || [ -z "$VERSION" ] ; then
-	echo "Usage: $0 <tool_name> <version>"
+if ! [ -f "$TOOL_DIR/go.mod" ] ; then
+	echo "Not a valid tool directory: $TOOL_DIR"
+	echo "Usage: $0 [<tool_dir>] [<version>]"
 	exit 1
 fi
 
+BASE_DIR=$(readlink -f $(dirname $0)/..)
 DIR=${BASE_DIR}/distrib
 
 hash_file() {
@@ -71,5 +72,9 @@ build_for_arch "linux" "amd64" "x86_64-linux-gnu"
 build_for_arch "linux" "arm64" "aarch64-linux-gnu"
 build_for_arch "darwin" "amd64" "i386-apple-darwin11"
 build_for_arch "windows" "386" "i686-mingw32"
-build_json
-echo "Build completed for $TOOL_NAME $VERSION: $DIR/$TOOL_NAME-$VERSION.json"
+if [ "${VERSION}" == "dev" ] ; then
+	echo "Build completed for $TOOL_NAME $VERSION in $DIR"
+else
+	build_json
+	echo "Build completed for $TOOL_NAME $VERSION: $DIR/$TOOL_NAME-$VERSION.json"
+fi

extra/sync-zephyr-artifacts/README.md

@@ -0,0 +1,26 @@
+## Sync Zephyr Artifacts tool
+
+This tool fetches the pre-built files that are associated with the current
+revision of the Arduino core for Zephyr. This makes it possible to use the
+repository as a local core with the Arduino IDE without the need to have the
+full Zephyr build system installed and configured.
+
+Pre-built files are generated only for the most recent commits in each branch.
+If in doubt, checkout the current version of the branch you are interested in
+before running the tool.
+
+### Getting the tool
+
+If you have installed the Arduino IDE and the Arduino core for Zephyr, you can
+find the pre-built files in the `.arduino15/packages/arduino/tools/` folder in
+your home directory. You can directly use the tool from there.
+
+### Building manually
+
+To build the tool, you need to have the Go programming language installed; make
+sure you have the `go` command available in your PATH. Then, use the `go build`
+command to build the tool for your platform.
+
+To build the full set of binaries for all platforms, run the `package_tool.sh`
+script in the parent directory with `../package_tool.sh`, or provide the path
+to this directory as an argument.

extra/zephyr-sketch-tool/README.md

@@ -0,0 +1,26 @@
+## Zephyr Sketch Tool
+
+This tool converts various binary files into a format that can be used
+by the Zephyr loader.
+
+The loader expects to find a specific header in a fixed location in the binary
+file, with information about the sketch and the build options chosen by the
+user. The location of the header was selected so that it affects unused bytes
+in the ELF file format; when dealing with binary files, 16 bytes are added at
+the beginning to reserve space for the header.
+
+### Getting the tool
+
+If you have installed the Arduino IDE and the Arduino core for Zephyr, you can
+find the pre-built files in the `.arduino15/packages/arduino/tools/` folder in
+your home directory. You can directly use the tool from there.
+
+### Building manually
+
+To build the tool, you need to have the Go programming language installed; make
+sure you have the `go` command available in your PATH. Then, use the `go build`
+command to build the tool for your platform.
+
+To build the full set of binaries for all platforms, run the `package_tool.sh`
+script in the parent directory with `../package_tool.sh`, or provide the path
+to this directory as an argument.