baz/doc/BAZ_ENV.md
Ari Archer f4ea9444ea
6.0.0-pre : improve wording, update only on version change, add baz_setup.sh
Signed-off-by: Ari Archer <ari.web.xyz@gmail.com>
2023-02-13 00:20:57 +02:00

810 B

the index file

the index file ( baz.env ) defines all metadata about your plugin, it should have these variables :

  • BAZP_NAME -- the plugin name
  • BAZP_LICENSE -- the plugin license
  • BAZP_VER -- the plugin version ( a number incrementing by 1 every version [1, 2, 3, ... 65, 66, 67, ...] )
  • BAZP_AUTHOR -- the author of the plugin ( can be your full name, your username, email, whatever )
  • BAZP_SRC -- the source / plugin folder ( see plugin folder structure docs )
  • BAZP_METHOD -- the recommended method to install this plugin ( like git, local, ... )
  • BAZP_SOURCE -- the source of your plugin ( might be an external link, a directory name ( like . for example ), a GitHub repo, anything )
  • BAZP_DESCRIPTION -- the description of your plugin