diff options
| author | Johannes Rudolph <johannes_rudolph@gmx.de> | 2012-10-16 14:31:24 +0200 |
|---|---|---|
| committer | Johannes Rudolph <johannes_rudolph@gmx.de> | 2012-10-16 14:31:24 +0200 |
| commit | d38c64d4a5fa32b936e86cdb58c4ec20e82fb1dc (patch) | |
| tree | 669680427f3d5b4a6f391031d9cadaa14a27d013 | |
| parent | 3dc171e41676e9043fe0c6d935b97a944c143dad (diff) | |
| download | sbt-boilerplate-d38c64d4a5fa32b936e86cdb58c4ec20e82fb1dc.tar.gz sbt-boilerplate-d38c64d4a5fa32b936e86cdb58c4ec20e82fb1dc.tar.bz2 sbt-boilerplate-d38c64d4a5fa32b936e86cdb58c4ec20e82fb1dc.zip | |
readme tweaks
| -rw-r--r-- | README.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -4,14 +4,14 @@ Boilerplate is an sbt-plugin that generates stubs for code which has to be expan for all numbers of arguments from 1 to 22. This is sometimes necessary to support all of the `TupleX` or `FunctionX` generically. -The plugin defines a simple template language for just this purpose. +The plugin defines a simple template language for this purpose. ## The template language The template file contains mostly literal code with some control characters guiding the expansion. Expansion follows these rules: - - There's a current number of arguments `i` which is initialized to 22. + - The current number of arguments `i` is initialized to 22. - Code embraced in `[#` and `#]` is copied `i` times and the expansion is applied recursively with `i` being set accordingly. It is possible to define a custom separator between the copied instances by putting the separator text between the `#` and the `]` of the closing @@ -86,6 +86,11 @@ The templates have to be put into the `src/main/boilerplate` directory and the f must end with `.template`. The generated files will be put into the same hierarchy as they appear in `src/main/boilerplate` with the `.template` extension stripped off. +## Known issues + + * The maximum number of arguments, 22, is hard-coded. + * Instances for 0 arguments have to be supplied manually. + ## License Copyright (c) 2012 Johannes Rudolph |