Packages

plantuml_mix

0.0.1
0.0.1

Add plantuml task to mix. Execute mix plantuml --help for options. Requires that the env var PLANTUML_JAR points to a valid PlantUML jar file. Requires Java > 1.6 installed on the system.

Current section

Files

Jump to
Readme
1 Version
0 Dependencies
Dependants
Files
Activity
plantuml_mix README.md
Raw

README.md 

# plantuml mix task 



## Installation





Add elixirci to your list of dependencies in `mix.exs` :



        def deps do

          [

            {:plantuml_mix, "~> 0.0.1"}

          ]

        end



Requires that the environment variable `PLANTUML_JAR` exists and is set to the path for 'plantuml.jar'.

I have not verified that paths containing spaces work correctly. 



## Usage Examples:



```

mix plantuml

Generating images from diagrams/*.puml to diagrams

```



## `mix help plantuml`



Run plantuml, specifying source glob and destination directory.



```

mix plantuml --source "diagrams/*.puml" --dest "diagrams"

```

Args:

* `--help`  :  display this help

* `--source`: <source glob>

* `--dest`  : <destination directory>



Location: _build/dev/lib/plantuml_mix/ebin