Skip to content
This repository has been archived by the owner on Sep 12, 2024. It is now read-only.

Commit

Permalink
Merge pull request #8 from devklick/dev
Browse files Browse the repository at this point in the history
Update `list` command shorthand, update docs
  • Loading branch information
devklick authored Apr 28, 2024
2 parents 351a269 + 4a7ffcc commit 25296bd
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
5 changes: 3 additions & 2 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@
"args": [
// "current",
// "list"
"install",
// "install",
"i",
// "--help",
// "--latest",
// "--flavour", "mono"
"--version", "v4.2.2-stable"
"--version", "4.2.2-stable"
]
},
{
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ This will allow you to invoke two commands from your terminal:

To install a version of Godot, you run the `install` command.

> [!NOTE]
> The shorthand command for `install` is `i`
> [!WARNING]
> GDMan does not support versions version of Godot < 4.
> This is because the naming convention for it's assets changed considerably.
Expand Down Expand Up @@ -134,6 +137,10 @@ To view all of the versions of Godot that are installed on your system, run the
gdman list
```

> [!NOTE]
> The shorthand command for `list` is `ls`
> [!WARNING]
> This will only list version installed by GDMan
## List active version
Expand All @@ -143,3 +150,6 @@ To see the version of Godot that is currently active, run the `current` command
```
gdman current
```

> [!NOTE]
> The shorthand command for `current` is `c`
2 changes: 1 addition & 1 deletion src/GDMan.Cli/Options/ListOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace GDMan.Cli.Options;

[Command("list", "l", "Lists the versions of Godot currently installed on the system")]
[Command("list", "ls", "Lists the versions of Godot currently installed on the system")]
public class ListOptions : BaseOptions
{
}

0 comments on commit 25296bd

Please sign in to comment.