diff --git a/README.md b/README.md index 261865ede4ec5970c837714c0fea356b58f1e628..2be74475af1a688d19324ed80732ede2ea2e856a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ Enables Julia code and Tikz code to coexist in the same file. ### JuliaTikz +```julia JuliaTikz(tikzfile,delete=true) +``` Extract and run the Julia part of a combined tikz/Julia file. @@ -14,7 +16,7 @@ The boundary between the two is the string where `<name>` is the name that will be given to the Julia file (with .jl appended), and also to a variable `name` in the program, -i.e. name = "<name>". +i.e. `name = "<name>"`. The Julia file will be extracted to a temporary directory, which will be deleted after the run unless the optional argument `delete` is false.