Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

General fixes to README #429

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

General fixes to README #429

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a44506
feat: fixed typos in README
paniash Jun 30, 2021
d8d45e4
added REPL code to code blocks
paniash Jun 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.


Expand Down