Skip to content

Commit 01d62d8

Browse files
committed
Update README
1 parent 971cacf commit 01d62d8

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

DEVELOPING.mkdn

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,18 @@ So you've decided to add a subcommand to Humility. Here's what you need to do.
3636
make sure any new name starts with `humility-cmd-` (e.g.
3737
`humility-cmd-yourcommand`).
3838

39-
2. Review the settings in the `init` routine you cribbed from to make sure they
40-
reflect your subcommand. In particular, the name must appear a second time in
41-
the `name:` field.
42-
43-
3. Cite your new subcommand from the root `Cargo.toml`. This needs to happen in
39+
2. Cite your new subcommand from the root `Cargo.toml`. This needs to happen in
4440
three places using two different names: in the `workspace.members` element
4541
using the relative path (e.g. `cmd/yourcommand`); in the
4642
`workspace.dependencies` section using the name of your package with the
4743
leading `humility-` stripped off, so e.g. `cmd-yourcommand`; and then in the
4844
`dependencies` table with a line reading `cmd-yourcommand = {workspace =
4945
true}`.
5046

51-
4. Regenerate the README file by running `cargo xtask readme`. The `xtask` bit
47+
3. Regenerate the README file by running `cargo xtask readme`. The `xtask` bit
5248
there is very important.
5349

54-
5. If you're adding a new command, you almost certainly want to bump Humility's
50+
4. If you're adding a new command, you almost certainly want to bump Humility's
5551
patch version. This makes it easier to tell whether users have the command.
5652
Doing this requires an extra step compared to a normal Rust package; see the
5753
previous section in this file.

0 commit comments

Comments
 (0)