Getting Started

Getting started

Installation

Just clone the repo and add the git dir to the PATH variable:

git clone git@github.com:OpenCockpit/SkinForge.git

Quick start

zmlcompile <domain> [srcbase] [dstbase] [cmnbase]

<domain> is the plugin's directory name.

The base-path arguments are optional and independently default to $HOME/git/dev, $HOME/git/rel, and $HOME/git/Common — pass them to build against a different checkout (e.g. a worktree) without touching $HOME/git: srcbase roots the plugin's own source, dstbase the destination tree, and cmnbase the shared Common tree.

.xmlinc files are generated on demand

.xmlinc includes are not kept in git. When xmlinc (src/xmlinc.py) looks for an include foo.xmlinc and finds none, it converts the foo.ymlinc next to where it would be (yml2xml, then xmlpretty) into a temporary directory, uses that, and removes the directory when it exits. A real .xmlinc file still wins if one exists (hand-written includes keep working). yml2xmldomain now only converts the full .yml documents (skin.yml -> skin.xml).