Skip to content

Commit

Permalink
add info about global DrWatson (#262)
Browse files Browse the repository at this point in the history
  • Loading branch information
Datseris authored Jun 14, 2021
1 parent 03efc24 commit 982dc28
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "DrWatson"
uuid = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
repo = "https://github.com/JuliaDynamics/DrWatson.jl.git"
version = "2.0.4"
version = "2.0.5"

[deps]
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
Expand Down
9 changes: 5 additions & 4 deletions src/project_setup.jl
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,11 @@ it matches the `name`.
!!! warning
Note that to access `quickactivate` you need to be `using DrWatson`.
For this to be possible `DrWatson` must be already added in the
existing global environment. The version of `DrWatson` loaded therefore
will be the one of the global environment, and not of the activated project.
To avoid unexpected behavior take care so that these two versions coincide.
existing global environment. If you use `quickactivate` and share your project, do
note to your co-workers that they need to add `DrWatson` globally (the default
README.md created by `initialize_project` says this automatically).
**In addition please be very careful to write:**
**In addition, in your scripts write:**
```julia
using DrWatson # YES
quickactivate(@__DIR__)
Expand Down Expand Up @@ -219,6 +219,7 @@ function DEFAULT_README(name, authors = nothing)
1. Open a Julia console and do:
```
julia> using Pkg
julia> Pkg.add("DrWatson") # install globally, for using `quickactivate`
julia> Pkg.activate("path/to/this/project")
julia> Pkg.instantiate()
```
Expand Down

0 comments on commit 982dc28

Please sign in to comment.