Skip to content

Commit a74dcc3

Browse files
committed
Update README and CONTRIBUTING.md
1 parent db0e866 commit a74dcc3

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You will see that hg-setup is based on [Click] (for the command line interface)
1818
[Textual] (for the terminal user interfaces).
1919

2020
Note also that we require Python >=3.11, to ease the development and because hg-setup is
21-
going to be installed with tools (UV, Pixi) for which is not difficult to get a recent
21+
going to be installed with tools (UV, Pixi) for which it is not difficult to get a recent
2222
Python.
2323

2424
[click]: https://click.palletsprojects.com

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
[![Github Actions](https://github.com/fluiddyn/hg-setup/actions/workflows/ci.yml/badge.svg?branch=branch/default)](https://github.com/fluiddyn/hg-setup/actions)
77

88
hg-setup can be used to setup [Mercurial]. The main command provided by this package,
9-
`hg-setup init` launches a simple Terminal User Interface (TUI) to initialize a
9+
`hg-setup init`, launches a simple Terminal User Interface (TUI) to initialize a
1010
reasonable user configuration file and shell completion for bash and zsh.
1111

12-
With [UV], one can run it without installation with:
12+
With [UV], one can even run it without installation with:
1313

1414
```sh
1515
uvx hg-setup init
@@ -19,12 +19,12 @@ uvx hg-setup init
1919

2020
[Mercurial] is a Python application using C and Rust extensions. It is extendable with
2121
Mercurial extensions and two Python packages provide very useful Mercurial extensions
22-
that most users should use : [hg-git] (Mercurial extension hggit) and [hg-evolve]
23-
(Mercurial extensions topic and evolve).
22+
that most users should use : [hg-git] (Mercurial extension `hggit`) and [hg-evolve]
23+
(Mercurial extensions `topic` and `evolve`).
2424

2525
These things are packaged in 3 PyPI packages (associated with their equivalent
2626
conda-forge packages): mercurial, hg-git, hg-evolve. Moreover, to use Mercurial
27-
extensions, one has to write few lines in a configuration file (~/.hgrc).
27+
extensions, one has to write few lines in a configuration file (`~/.hgrc`).
2828

2929
Mercurial with hg-git and hg-evolve is great but it is a bit difficult to setup for
3030
beginners. hg-setup is there to help people to start with Mercurial and finalize its
@@ -66,8 +66,6 @@ conda-app install hg-setup
6666
- With [Pixi]
6767

6868
```sh
69-
pixi global install mercurial-app
70-
# or (equivalent)
7169
pixi global install mercurial --with hg-git --with hg-evolve
7270
# and then
7371
pixi global install hg-setup

0 commit comments

Comments
 (0)