Skip to content

Commit

Permalink
Some improvements to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Niols committed Nov 4, 2024
1 parent 3a8038d commit 10ffd24
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,15 @@ How to update
“failed to get `<whatever>` as a dependency of package `topiary`”.

- Update the `Cargo.toml` file. This usually consists in copying the content of
`topiary/Cargo.toml` file, except for the `workspace.members` attribute. This
step should include bumping the version number.
`topiary/Cargo.toml` file and prefixing all the local paths by `topiary/`. In
particular, `workspace.members` and `workspace.default-members` need to be
updated. Sometimes, locally vendored dependencies might need the same
treatment, as in for instance:
```toml
topiary-web-tree-sitter-sys = { version = "0.5.1", path = "./topiary/topiary-web-tree-sitter-sys" }
```
Make sure that the version number in `Cargo.toml` is correct; this is trivial
if it was copied from the `topiary/` submodule.

- Update the `Cargo.lock` file. Again, this usually consists in copying the one
from `topiary/Cargo.lock`.
Expand Down Expand Up @@ -258,8 +265,11 @@ How to update

- Adapt the OPAM package or the other files if necessary and commit the changes.

- Open a [new pull request] and check that the continuous integration is happy
with the current status of things. Merge the pull request in question.
- Test that it looks like it works (see [How to develop](#how-to-develop)).

- Open a [new pull request] on this repository and check that the continuous
integration is happy with the current status of things. Merge the pull request
in question.

- Add a tag mimmicking that of Topiary (eg. `v0.1.0` for Topiary's `v0.1.0`).

Expand Down

0 comments on commit 10ffd24

Please sign in to comment.