Skip to content
Merged

typo #85

Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@ and include some outdated API, especially in Tutorial 5.

The tutorials are embedded in Documenter.jl documentation, and live at
[/docs/src/notebooks/](/docs/src/notebooks/). **The ground truth for content is the julia
scripts,** which must follow the
scripts with the name "notebook.jl"** which must follow the
[Literate.jl](https://duckduckgo.com/?q=Literate.jl&t=osx&ia=web) rules for embedding the
narrative as code comments.
narrative as code comments.

Package management is through a workspace tree with /Project.toml as the root
project. Each notebook gets its own Project.toml file in the workspace tree. The julia
version is specified in the root Project.toml. There are no committed manifests, only
project files with [compat] lower bounds.
project. Each tutorial gets its own Project.toml file in the workspace
tree. The julia version is specified in the root Project.toml. There are no committed
manifests, only project files with [compat] lower bounds.

An optional runtest.jl file can be added to any tutorial folder for CI testing of
consistency of the tutorial with the narrative. This should begin with the line
`include("tutorial.jl")` and end with `true`.
`include("notebook.jl")` and end with `true`.

After making changes to a julia script or any Project.toml file, post a pull request and
CI will automatically generate new markdown (using Literate.jl), inviting you to review a
Expand Down
Loading