Update 'README.md'

pr^2
Maxime BATISTA 2 years ago
parent b21df79890
commit fc58766233

@ -34,7 +34,7 @@ Usage examples :
The `-t <g>` (`--type <g>`) option lookups for a generator script `<g>`.sh to be present in the `/generators` The `-t <g>` (`--type <g>`) option lookups for a generator script `<g>`.sh to be present in the `/generators`
(ex: `--type doxygen` searchs for a `/generators/doxygen.sh` file script). (ex: `--type doxygen` searchs for a `/generators/doxygen.sh` file script).
You can add your own generator by simply moving your script into the `/generators` file You can add your own generator by simply moving your script into the `/generators` folder
Furthermore, your generator MUST follow below specifications : Furthermore, your generator MUST follow below specifications :
* Define a `generate()` function that will be called, assuming that `$1` equals to the value passed after `-l` (`--loc`) which is the documentation sources location * Define a `generate()` function that will be called, assuming that `$1` equals to the value passed after `-l` (`--loc`) which is the documentation sources location

Loading…
Cancel
Save