diff --git a/README.md b/README.md index a8724e42d20b177599107a755384f656ee3689d8..0a7faa8c0b8fe51ef853649d136604a8c7836eed 100644 --- a/README.md +++ b/README.md @@ -20,17 +20,14 @@ existing Hackage package(s). ## How this works -This repo contains `<pkg-id>.patch` and `<pkg-id>.cabal` files in the +This repo contains `<pkg-id>.patch`` files in the [`patches/`](./patches/) folder (where `<pkg-id>` refers to a specific release of a package, e.g. `lens-4.15.3`). Once merged to `master`, all package releases whose `<pkg-id>` is mentioned will enter the *HEAD.hackage* package index; if there is a `.patch` file, the respective releases tarballs are patched -(i.e. mutated!). If there is a `.cabal` file, it is included as a -revision in the package index. Consequently, if there is only a -`.cabal` file and no `.patch` file, the original source `.tar.gz` is -included in verbatim (i.e. *not* mutated). +(i.e. mutated!). If this operation succeeds, the `HEAD.hackage` package index at http://HEAD.hackage.haskell.org/ is updated to contain the new index