Skip to content

Commit ea6b572

Browse files
committed
Update README.md
1 parent d4b77d6 commit ea6b572

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,24 @@ GracefulPkg.resolve() # works!
2323

2424

2525
## Use in Pluto.jl
26-
*(TODO after release)* GracefulPkg.jl is used by [Pluto.jl](https://plutojl.org/) when launching a notebook with an embedded package environment. Pluto will try to reproduce the environment used to write the notebook. If this does not work, the strategies from GracefulPkg are used to make sure that the notebook can still launch.
27-
28-
TODO this code is currently still in the Pluto codebase as the function `with_auto_fixes`.
26+
GracefulPkg.jl is used by [Pluto.jl](https://plutojl.org/) when launching a notebook with an embedded package environment. Pluto will try to reproduce the environment used to write the notebook. If this does not work, the strategies from GracefulPkg are used to make sure that the notebook can still launch.
2927

3028
> 🙋 GracefulPkg is based on experiences from the Pluto developers, seeing countless notebooks "in the wild". Pluto notebooks should **always run**, trying to maintain as much of the original environment as possible. The strategies in GracefulPkg were found to fix most environments in the least invasive way possible.
3129
3230
## Strategies
3331
GracefulPkg comes with the following strategies as defaults:
3432
1. Do nothing
3533
1. Fix any stdlib compat issues (from "freed" stdlibs like Statistics or new stdlibs like StyledStrings)
34+
1. Run `Pkg.instantiate` if needed
3635
1. *(TODO)* Run `Pkg.build` on packages that asked for it
3736
1. Update registries
37+
1. Loosen version compat entries from Project.toml, for packages that asked for it in the error message.
3838
1. Remove Manifest.toml
39-
1. Remove Manifest.toml and loosen any version compat entries from Project.toml, leaving only `[deps]`.
39+
1. Remove Manifest.toml and remove all compat entries from Project.toml, leaving only `[deps]`.
40+
1. Remove Manifest.toml and Project.toml.
4041

4142

4243
# Test
43-
This package is tested against [a library](https://github.com/JuliaPluto/GracefulPkg.jl/tree/main/test/fixtures) of Project.toml + Manifest.toml files that we found in the wild, or that we hand-crafted to simulate a possible tricky situation.
44-
44+
This package is tested against [a collection](https://github.com/JuliaPluto/GracefulPkg.jl/tree/main/test/fixtures) of Project.toml + Manifest.toml files that we found in the wild, or that we hand-crafted to simulate a possible tricky situation.
4545

4646
This package is also tested with some older Julia versions (1.6, 1.8 and 1.9). This increases the number of tricky Julia combinations that we can test against, which hopefully means the package is more robust (for future Julia versions).

0 commit comments

Comments
 (0)