From 70bc04bd03b590102f054eb9f50ec61c4889566e Mon Sep 17 00:00:00 2001 From: Leif Andersson <leif.andersson@control.lth.se> Date: Sat, 30 Sep 2023 16:52:34 +0200 Subject: [PATCH] Correct README.md --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ebea6f7..13a7b5d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # ModJuliaTikz.jl -Enables Julia code and Tikz code to coexist in the same file. +Enables Julia code and Tikz code to coexist in the same file. -### JuliaTikz +For installation, se the end of this README, +### JuliaTikz ` JuliaTikz(tikzfile,delete=true)` - Extract and run the Julia part of a combined tikz/Julia file. The boundary between the two is the string @@ -32,3 +32,16 @@ as the remaining elements. The default name of the file will be `<name>.csv`, where `<name>` is the value of the global variable `name`, typically given by `JuliaTikz`. Another name may be specified whith the second argument of `printcsv`. + +## installation +To install, start by pushing the `clone` button in this repo and copying the URL. + The HTTPS version should always work, the SSH version should work if you have a +suitable ssh key. + +Enter the Pkg REPL by pressing `]` from the Julia REPL. You should get a prompt like +`(@v1.9) pkg> `. To add this package, type + +` (@v1.9) pkg> add <URL> ` + +where `<URL>` is the value you got from the clone commands above. Leave the Pkg by +pressing backspace or ^C. You can now type `using ModJuliaTiz` if you like. -- GitLab