Wok structure

wok is a collection of recipes. You put your recipes in the wok and get ready-made packages.

The recipe file must have the same name as the main package, that is, what is specified in the "name" field. The file extension must be ".yaml". Thus, the recipe describing the package "foo" should be named "foo.yaml".

For convenience, recipes can be grouped into arbitrary collections. For example, the recipes "foo.yaml" and "bar.yaml" can be placed in the common folder "baz". All packages with Perl modules can be put into the "perl" folder, all packages with Python modules — into the "python" folder, all X.org project packages into the "xorg" folder, and so on.

When there are too many recipes, there is a problem to find a specific recipe in a variety of folders. BBQ has a command that allows you to find the specified recipe in the wok.

No other files except recipes and accompanying files should be placed in the wok: the source code is compiled and packages are packaged elsewhere in the file system.

Icons

Allowed icons in PNG or SVG format. The preferred size is 48×48 pixels.

Conventions on file name with icon. For example, for the recipe "foo": if the icon file "foo.png" or "foo.svg" is found in the same folder as the recipe file "foo.jaml", it will be used. Otherwise, the "icon.png" or "icon.svg" icon from the same folder will be used. If it is not found, an attempt will be made to find the "icon.png" or "icon.svg" in the parent folder, and so on. Therefore, the wok root should have a default icon.