diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa259f2..b10c3e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,11 +7,23 @@ Please note we have a code of conduct, please follow it in all your interactions # Julia Development Environment -``` +Link your local git repository to Julia: +```console $ ln -s ~/path/to/TrainRun.jl ~/.julia/dev/TrainRun ``` -and use `Revise.jl` +Have a look here how to develop Julia packages: https://github.com/ShozenD/julia-pkg-dev +You might want to use `Revise.jl` as well: +```julia +Pkg.add("Revise") +``` +and then just load with `using Revise` (preferably by putting it in the `~/.julia/config/startup.jl` file) + +```julia +(@v1.x) pkg> develop TrainRun +(@v1.x) pkg> activate TrainRun +(TrainRun) pkg> +``` # Pull Request Process