Skip to content

Commit 982dc28

Browse files
authored
add info about global DrWatson (#262)
1 parent 03efc24 commit 982dc28

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

Project.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "DrWatson"
22
uuid = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
33
repo = "https://github.com/JuliaDynamics/DrWatson.jl.git"
4-
version = "2.0.4"
4+
version = "2.0.5"
55

66
[deps]
77
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

src/project_setup.jl

+5-4
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,11 @@ it matches the `name`.
107107
!!! warning
108108
Note that to access `quickactivate` you need to be `using DrWatson`.
109109
For this to be possible `DrWatson` must be already added in the
110-
existing global environment. The version of `DrWatson` loaded therefore
111-
will be the one of the global environment, and not of the activated project.
112-
To avoid unexpected behavior take care so that these two versions coincide.
110+
existing global environment. If you use `quickactivate` and share your project, do
111+
note to your co-workers that they need to add `DrWatson` globally (the default
112+
README.md created by `initialize_project` says this automatically).
113113
114-
**In addition please be very careful to write:**
114+
**In addition, in your scripts write:**
115115
```julia
116116
using DrWatson # YES
117117
quickactivate(@__DIR__)
@@ -219,6 +219,7 @@ function DEFAULT_README(name, authors = nothing)
219219
1. Open a Julia console and do:
220220
```
221221
julia> using Pkg
222+
julia> Pkg.add("DrWatson") # install globally, for using `quickactivate`
222223
julia> Pkg.activate("path/to/this/project")
223224
julia> Pkg.instantiate()
224225
```

0 commit comments

Comments
 (0)