Skip to content

Commit 5fb3d2f

Browse files
committed
Correct comment on how to add local packages
1 parent 9f65a3a commit 5fb3d2f

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
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 = "1.6.0"
4+
version = "1.6.1"
55

66

77

docs/src/project.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,11 @@ initialize_project
4747
Notice that the project initialized by DrWatson does not represent a Julia package. It represents a scientific project. That being said, it is often the case that you want to develop normal Julia Modules inside your project, so that you can later use them in your code with `using PackageName`. The proper way to do this is to initialize Julia packages, using the package manager, inside the `src` folder, using these steps:
4848

4949
1. Active your project that uses DrWatson.
50-
2. Change directory to the project's `src` folder.
51-
3. Go into package mode and initialize a package with the name that you want: `generate PackageName`
52-
4. `dev` the local path to `PackageName` using the package manager , e.g. `dev PackageName`. Notice that this command uses a local path, see this PR for more details: https://github.com/JuliaLang/Pkg.jl/pull/1215
50+
2. Change directory to the project's folder (very important).
51+
3. Go into package mode and initialize a package with the name that you want: `generate src/PackageName`
52+
4. `dev` the local path to `PackageName` using the package manager , e.g. `dev src/PackageName`. Notice that this command uses a local path, see [this PR](https://github.com/JuliaLang/Pkg.jl/pull/1215) for more details.
5353

54+
Now whenever you do `using PackageName`, the local version will be used. This will still work even if you transfer your project to another computer, because the Manifest.toml file stores the local path.
5455

5556

5657
## Activating a Project

0 commit comments

Comments
 (0)