Skip to content

Commit d95ca55

Browse files
committed
chore: update README
1 parent 6da14db commit d95ca55

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Toolkit
22

3-
Toolkit is a CLI that helps you to initialize your development env faster.
3+
Toolkit is a CLI that helps you to initialize your development environment faster.
44

55
## Features
66

@@ -16,31 +16,43 @@ Toolkit is a CLI that helps you to initialize your development env faster.
1616

1717
You can download the toolkit CLI from the [release page](https://github.com/apptools-lab/AppToolkit/releases).
1818

19-
### 2. Run the Toolkit
19+
### 2. Extract the Zip
20+
21+
Extract the zip file to your local directory. Then you will get the `toolkit` binary file(macOS & Linux) or `toolkit.exe` file(Windows).
22+
23+
### 3. Run the Toolkit
2024

2125
#### Windows
2226

2327
```shell
24-
# Install the recommended toolkits(for web development)
25-
$ toolkit.exe install
26-
# Install your toolkits
27-
$ toolkit.exe install --manifest <your-manifest-path>
28+
# cd the directory where the `toolkit` file is located
29+
$ cd .\Downloads
30+
31+
# install the recommended toolkits(for web development)
32+
$ .\toolkit.exe install
33+
# install your custom toolkits by specifying the manifest file path
34+
$ .\toolkit.exe install --manifest <your-manifest-path>
2835
```
2936

3037
**NOTE: Currently, you may need to follow the installtion instructions to install tools manually on Windows system.**
3138

3239
#### Macos & Linux
3340

3441
```shell
35-
# Install the recommended toolkits(for web development)
36-
$ toolkit install
37-
# Install your toolkits
38-
$ toolkit install --manifest <your-manifest-path>
42+
# cd the directory where the `toolkit` file is located.
43+
$ cd ~/Downloads
44+
45+
$ chmod +x toolkit
46+
47+
# install the default toolkits (for web development)
48+
$ ./toolkit install
49+
# install your toolkits by specifying the manifest file path
50+
$ ./toolkit install --manifest <your-manifest-path>
3951
```
4052

4153
## Customization
4254

43-
You can customize your tools which to be installed in a json file. Here we provide a [json schema](https://raw.githubusercontent.com/apptools-lab/AppToolkit/feat/cli/toolkits.schema.json) for you to follow and you can get the hint in the popular IDEs like Visual Studio Code, IntelliJ and so on. For Example:
55+
You can customize your tools which to be installed in a json file. Here is a [json schema](https://raw.githubusercontent.com/apptools-lab/AppToolkit/feat/cli/toolkits.schema.json) for you to follow and you can get the hint in the popular IDEs like Visual Studio Code, IntelliJ and so on. For Example:
4456

4557
```json
4658
{
@@ -85,8 +97,8 @@ Then you can install your custom tools with the following command:
8597

8698
```shell
8799
# windows
88-
$ toolkit.exe install --manifest <your-manifest-path>
100+
$ .\toolkit.exe install --manifest https://the-remote-server/your-manifest-path
89101

90102
# macos & linux
91-
$ toolkit install --manifest <your-manifest-path>
103+
$ ./toolkit install --manifest https://the-remote-server/your-manifest-path
92104
```

0 commit comments

Comments
 (0)