From 2a44506fdace2ee4f8124e5fe501d570e751c38b Mon Sep 17 00:00:00 2001 From: Ashish Panigrahi Date: Wed, 30 Jun 2021 18:56:01 +0530 Subject: [PATCH 1/2] feat: fixed typos in README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 847565fd..074abe0c 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Pkg.add("Weave") ```julia using Weave -# add depencies for the example +# add dependencies for the example using Pkg; Pkg.add(["Plots", "DSP"]) filename = normpath(Weave.EXAMPLE_FOLDER, "FIR_design.jmd") @@ -60,7 +60,7 @@ filename = normpath(Weave.EXAMPLE_FOLDER, "FIR_design.jmd") weave(filename, out_path = :pwd, doctype = "md2pdf") ``` -NOTE: `Weave.EXAMPLE_FOLDER` just points to [`examples` directory](./examples). +NOTE: `Weave.EXAMPLE_FOLDER` just points to [`examples`](./examples) directory. ## Documentation @@ -89,7 +89,7 @@ We'd also appreciate more example documents written using Weave. ## Contributors -You can see the list of contributors on GitHub: https://github.com/JunoLab/Weave.jl/graphs/contributors . +You can see the list of contributors on GitHub: https://github.com/JunoLab/Weave.jl/graphs/contributors. Thanks for the important additions, fixes and comments. From d8d45e4a7cfa380249f3f6c90649ed18dd897ea5 Mon Sep 17 00:00:00 2001 From: Ashish Panigrahi Date: Wed, 30 Jun 2021 18:58:57 +0530 Subject: [PATCH 2/2] added REPL code to code blocks --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 074abe0c..b5b873a4 100644 --- a/README.md +++ b/README.md @@ -36,28 +36,28 @@ and then use `weave` function to execute code and generate an output document wh You can install the latest release using Julia package manager: ```julia -using Pkg -Pkg.add("Weave") +julia> using Pkg +julia> Pkg.add("Weave") ``` ## Usage ```julia -using Weave +julia> using Weave # add dependencies for the example -using Pkg; Pkg.add(["Plots", "DSP"]) +julia> using Pkg; Pkg.add(["Plots", "DSP"]) -filename = normpath(Weave.EXAMPLE_FOLDER, "FIR_design.jmd") -weave(filename, out_path = :pwd) +julia> filename = normpath(Weave.EXAMPLE_FOLDER, "FIR_design.jmd") +julia> weave(filename, out_path = :pwd) ``` If you have LaTeX installed you can also weave directly to pdf. ```julia -filename = normpath(Weave.EXAMPLE_FOLDER, "FIR_design.jmd") -weave(filename, out_path = :pwd, doctype = "md2pdf") +julia> filename = normpath(Weave.EXAMPLE_FOLDER, "FIR_design.jmd") +julia> weave(filename, out_path = :pwd, doctype = "md2pdf") ``` NOTE: `Weave.EXAMPLE_FOLDER` just points to [`examples`](./examples) directory.