Skip to content

Commit e48668a

Browse files
Cleanup docs (#88)
1 parent cf2ff42 commit e48668a

4 files changed

Lines changed: 14 additions & 10 deletions

File tree

CHANGELOG

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# 0.2.3
2+
3+
* Cleanup help and docs, removing mentions to the update/remove keywords
4+
15
# 0.2.2
26

37
* `kup publish` returns exit code 1 if `cachix push/pin` commands fail

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,31 @@
66
bash <(curl https://kframework.org/install)
77
```
88

9-
You can then install K Framework via:
9+
You can then install/update K Framework via:
1010

1111
```
1212
kup install k
1313
```
1414

15-
update K with:
15+
remove K via
1616

1717
```
18-
kup update k
18+
kup uninstall k
1919
```
2020

21-
And list available versions with:
21+
and list available versions with:
2222

2323
```
2424
kup list k
2525
```
2626

27-
To list further available packages, run
27+
To list all available packages, run
2828

2929
```
3030
kup list
3131
```
3232

33-
and any further functionality is described in the help commands:
33+
Any further functionality is described in the help commands:
3434

3535
```
3636
kup --help

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
44

55
[tool.poetry]
66
name = "kup"
7-
version = "0.2.2"
7+
version = "0.2.3"
88
description = "kup is a tool for managing installations of the K framework along with the different available semantics"
99
authors = [
1010
"Runtime Verification, Inc. <contact@runtimeverification.com>",

src/kup/__main__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -799,13 +799,13 @@ def main() -> None:
799799
"""\
800800
additional information:
801801
For more detailed help for the different sub-commands, call
802-
kup {list,install,remove,update,shell} --help
802+
kup {list,install,add,shell} --help
803803
"""
804804
),
805805
)
806806
shared_args = ArgumentParser(add_help=False)
807807
shared_args.add_argument('package', type=str)
808-
shared_args.add_argument('--version', type=str, help='update the package to a custom version')
808+
shared_args.add_argument('--version', type=str, help='install the given version of the package')
809809
shared_args.add_argument(
810810
'--override', type=str, nargs=2, action='append', help='override an input dependency of a package'
811811
)
@@ -904,7 +904,7 @@ def main() -> None:
904904
if package_name.base in installed_packages:
905905
rich.print(
906906
f"❗ [red]The package '[green]{package_name.pretty_name}[/]' is currently installed and thus cannot be temporarily added to the PATH.\n"
907-
f"[/]Use:\n * '[blue]kup update {package_name.pretty_name} ...[/]' to replace the installed version or\n * '[blue]kup remove {package_name.base}[/]' to remove the installed version and then re-run this command"
907+
f"[/]Use:\n * '[blue]kup install {package_name.pretty_name} --version ...[/]' to replace the installed version or\n * '[blue]kup uninstall {package_name.base}[/]' to remove the installed version and then re-run this command"
908908
)
909909
return
910910

0 commit comments

Comments
 (0)