Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
luhc228 committed Jun 1, 2024
1 parent 6da14db commit d95ca55
Showing 1 changed file with 25 additions and 13 deletions.
38 changes: 25 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Toolkit

Toolkit is a CLI that helps you to initialize your development env faster.
Toolkit is a CLI that helps you to initialize your development environment faster.

## Features

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

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

### 2. Run the Toolkit
### 2. Extract the Zip

Extract the zip file to your local directory. Then you will get the `toolkit` binary file(macOS & Linux) or `toolkit.exe` file(Windows).

### 3. Run the Toolkit

#### Windows

```shell
# Install the recommended toolkits(for web development)
$ toolkit.exe install
# Install your toolkits
$ toolkit.exe install --manifest <your-manifest-path>
# cd the directory where the `toolkit` file is located
$ cd .\Downloads

# install the recommended toolkits(for web development)
$ .\toolkit.exe install
# install your custom toolkits by specifying the manifest file path
$ .\toolkit.exe install --manifest <your-manifest-path>
```

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

#### Macos & Linux

```shell
# Install the recommended toolkits(for web development)
$ toolkit install
# Install your toolkits
$ toolkit install --manifest <your-manifest-path>
# cd the directory where the `toolkit` file is located.
$ cd ~/Downloads

$ chmod +x toolkit

# install the default toolkits (for web development)
$ ./toolkit install
# install your toolkits by specifying the manifest file path
$ ./toolkit install --manifest <your-manifest-path>
```

## Customization

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:
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:

```json
{
Expand Down Expand Up @@ -85,8 +97,8 @@ Then you can install your custom tools with the following command:

```shell
# windows
$ toolkit.exe install --manifest <your-manifest-path>
$ .\toolkit.exe install --manifest https://the-remote-server/your-manifest-path

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

0 comments on commit d95ca55

Please sign in to comment.