diff --git a/README.md b/README.md index 0e35c3e..bbf7252 100644 --- a/README.md +++ b/README.md @@ -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 @@ -16,15 +16,22 @@ 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 +# 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 ``` **NOTE: Currently, you may need to follow the installtion instructions to install tools manually on Windows system.** @@ -32,15 +39,20 @@ $ toolkit.exe install --manifest #### Macos & Linux ```shell -# Install the recommended toolkits(for web development) -$ toolkit install -# Install your toolkits -$ toolkit install --manifest +# 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 ``` ## 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 { @@ -85,8 +97,8 @@ Then you can install your custom tools with the following command: ```shell # windows -$ toolkit.exe install --manifest +$ .\toolkit.exe install --manifest https://the-remote-server/your-manifest-path # macos & linux -$ toolkit install --manifest +$ ./toolkit install --manifest https://the-remote-server/your-manifest-path ```