Skip to content

Commit 6be65df

Browse files
Revise README for multilevel Distributed package
Updated README to reflect changes in package name and usage instructions.
1 parent 7d93f67 commit 6be65df

File tree

1 file changed

+5
-22
lines changed

1 file changed

+5
-22
lines changed

README.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Distributed (with a multiscale parallelism extension)
1+
# Distributed (multilevel extension)
22

33
The `Distributed` package provides functionality for creating and controlling
44
multiple Julia processes remotely, and for performing distributed and parallel
@@ -24,29 +24,12 @@ This package ships as part of the Julia stdlib.
2424
>
2525
> We are working on the implementation of case studies.
2626
27-
## Using development versions of this package
27+
## Using the multilevel version of Distributed
2828

29-
To use a newer version of this package, you need to build Julia from scratch. The build process is the same as any other build except that you need to change the commit used in `stdlib/Distributed.version`.
30-
31-
It's also possible to load a development version of the package using [the trick used in the Section named "Using the development version of Pkg.jl" in the `Pkg.jl` repo](https://github.com/JuliaLang/Pkg.jl#using-the-development-version-of-pkgjl), but the capabilities are limited as all other packages will depend on the stdlib version of the package and will not work with the modified package.
32-
33-
### On Julia 1.11+
34-
In Julia 1.11 Distributed was excised from the default system image and became
35-
more of an independent package. As such, to use a different version it's enough
36-
to just `dev` it explicitly:
29+
It is recommended to use Julia 1.11 or later. As described in the README of the original version's repository, you can configure your Julia environment to point to this version of `Distributed` using the following command:
3730
```julia-repl
38-
pkg> dev https://github.com/JuliaLang/Distributed.jl.git
31+
pkg> dev https://github.com/PlatformAwareProgramming/Distributed.jl
3932
```
40-
### On older Julia versions
41-
To use a newer version of this package on older Julia versions, you need to build
42-
Julia from scratch. The build process is the same as any other build except that
43-
you need to change the commit used in `stdlib/Distributed.version`.
44-
It's also possible to load a development version of the package using [the trick
45-
used in the Section named "Using the development version of Pkg.jl" in the
46-
`Pkg.jl`
47-
repo](https://github.com/JuliaLang/Pkg.jl#using-the-development-version-of-pkgjl),
48-
but the capabilities are limited as all other packages will depend on the stdlib
49-
version of the package and will not work with the modified package.
5033

5134
## API
5235

@@ -101,4 +84,4 @@ target - for example, `remotecall_fetch(myid, 2)` calls `myid()` on process 2.
10184
add or remove processes, and manages the rest of the cluster. Other processes
10285
(called "workers" or "worker processes") may still call functions on each other
10386
and send and receive data, but `addprocs`/`rmprocs` on worker processes will
104-
fail with an error.
87+
fail with an error.

0 commit comments

Comments
 (0)