Skip to content

Commit 327eed8

Browse files
authored
Add a README with instructions for developing the package locally (#55)
1 parent b384104 commit 327eed8

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Statistics.jl
2+
3+
Development repository for the Statistics standard library (stdlib) that ships with Julia.
4+
5+
#### Using the development version of Statistics.jl
6+
7+
If you want to develop this package, do the following steps:
8+
- Clone the repo anywhere.
9+
- In line 2 of the `Project.toml` file (the line that begins with `uuid = ...`), modify the UUID, e.g. change the `107` to `207`.
10+
- Change the current directory to the Statistics repo you just cloned and start julia with `julia --project`.
11+
- `import Statistics` will now load the files in the cloned repo instead of the Statistics stdlib.
12+
- To test your changes, simply do `include("test/runtests.jl")`.
13+
14+
If you need to build Julia from source with a git checkout of Statistics, then instead use `make DEPS_GIT=Statistics` when building Julia. The `Statistics` repo is in `stdlib/Statistics`, and created initially with a detached `HEAD`. If you're doing this from a pre-existing Julia repository, you may need to `make clean` beforehand.

0 commit comments

Comments
 (0)