Mhh... ReaPack displays the How and the Why at the same location to the user.
This:
Code:
--[[
ReaScript Name: This goes in the package browser.
Description: This script does awesome things that will make you save 1 hour of repetitive work each day!
Instructions: Clap in your hands twice and do a backflip to make this script works.
--]]
...is equivalent to this in 1.1beta1's way:
Code:
--[[
Description: This goes in the package browser.
About:
# Description
This script does awesome things that will make you save 1 hour of repetitive work each day!
# Instructions
Clap in your hands twice and do a backflip to make this script works.
--]]
With markdown formatting it's quite pretty. Two ideas come to mind:
- Some kind of script (or search/replace) to transform to new header, or
- Special case for this kind of header: the indexer do the transformation on the fly (= concatenate description and instructions, add the markdown title)
So it's downstream vs upstream, I guess.