Skip to content

Commit 556d029

Browse files
committed
Improve usage instructions
1 parent 5080597 commit 556d029

File tree

1 file changed

+19
-24
lines changed

1 file changed

+19
-24
lines changed

README.md

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,27 @@
44

55
The official [CodeGame](https://code-game.org) CLI.
66

7-
## Usage
7+
## Commands
8+
9+
### Docs and info
810

911
View the CodeGame documentation:
1012
```sh
1113
codegame docs
1214
```
1315

16+
View the documentation of a game:
17+
```sh
18+
codegame docs <url>
19+
```
20+
21+
Get information about a game server:
22+
```sh
23+
codegame info <url>
24+
```
25+
26+
### Project templates
27+
1428
Create a new project:
1529
```sh
1630
codegame new
@@ -26,6 +40,8 @@ Permanently switch to a different game URL:
2640
codegame change-url <new_url>
2741
```
2842

43+
### Running and building
44+
2945
Run a project:
3046
```sh
3147
codegame run
@@ -36,34 +52,13 @@ Build a project:
3652
codegame build
3753
```
3854

39-
Get information about a game server:
40-
```sh
41-
codegame info <url>
42-
```
43-
44-
View the documentation of a game:
45-
```sh
46-
codegame docs <url>
47-
```
55+
### Help
4856

49-
Help:
57+
Display help:
5058
```sh
5159
codegame --help
5260
```
5361

54-
## Features
55-
56-
- View the CodeGame documentation
57-
- View information about a game server
58-
- Automatic project setup
59-
- CodeGame version detection and management
60-
- Create a new client
61-
- Go
62-
- Create a new game server
63-
- Go
64-
- Initialize Git
65-
- Create README and LICENSE files
66-
6762
## Installation
6863

6964
### Windows

0 commit comments

Comments
 (0)