mirrors
/
Weave.jl
mirror of https://github.com/mpastell/Weave.jl
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge d8d45e4a7c into e10aaefd94

pull/429/merge
Ashish Panigrahi 2023-03-21 13:42:40 +08:00 committed by GitHub
parent e10aaefd94 d8d45e4a7c
commit 459b1cf31f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -36,31 +36,31 @@ 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 depencies for the example
using Pkg; Pkg.add(["Plots", "DSP"])
# add dependencies for the example
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` 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.