Skip to content

Commit

Permalink
Add a README with instructions for developing the package locally (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
DilumAluthge authored Oct 7, 2020
1 parent b384104 commit 327eed8
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Statistics.jl

Development repository for the Statistics standard library (stdlib) that ships with Julia.

#### Using the development version of Statistics.jl

If you want to develop this package, do the following steps:
- Clone the repo anywhere.
- In line 2 of the `Project.toml` file (the line that begins with `uuid = ...`), modify the UUID, e.g. change the `107` to `207`.
- Change the current directory to the Statistics repo you just cloned and start julia with `julia --project`.
- `import Statistics` will now load the files in the cloned repo instead of the Statistics stdlib.
- To test your changes, simply do `include("test/runtests.jl")`.

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 comments on commit 327eed8

Please sign in to comment.