Skip to content

Commit 575f7af

Browse files
authored
docs: update README with gitpick example (#290)
1 parent 92e35e7 commit 575f7af

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,36 @@ This repository contains comprehensive examples that demonstrate the Rstack ecos
44

55
## List of Examples
66

7-
| [Rspack](https://github.com/web-infra-dev/rspack) | <a href="https://github.com/web-infra-dev/rspack" target="blank"><img src="https://assets.rspack.dev/rspack/rspack-banner.png" width="400" /></a> | [Examples](./rspack) | [Document](https://rspack.dev/) |
8-
| :---------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------: | :-------------------------------: |
9-
| [Rsbuild](https://github.com/web-infra-dev/rsbuild) | <a href="https://github.com/web-infra-dev/rsbuild" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" width="400" /></a> | [Examples](./rsbuild) | [Document](https://rsbuild.dev/) |
10-
| [Rspress](https://github.com/web-infra-dev/rspress) | <a href="https://github.com/web-infra-dev/rspress" target="blank"><img src="https://assets.rspack.dev/rspress/rspress-banner.png" width="400" /></a> | [Examples](./rspress/) | [Document](https://rspress.dev/) |
11-
| [Rsdoctor](https://github.com/web-infra-dev/rsdoctor) | <a href="https://github.com/web-infra-dev/rsdoctor" target="blank"><img src="https://assets.rspack.dev/rsdoctor/rsdoctor-banner.png" width="400" /></a> | [Examples](./rsdoctor/) | [Document](https://rsdoctor.dev/) |
12-
| [Rslib](https://github.com/web-infra-dev/rslib) | <a href="https://github.com/web-infra-dev/rslib" target="blank"><img src="https://assets.rspack.dev/rslib/rslib-banner.png" width="400" /></a> | [Examples](https://github.com/web-infra-dev/rslib/tree/main/examples) | [Document](https://lib.rsbuild.dev/) |
7+
| [Rspack](https://github.com/web-infra-dev/rspack) | <a href="https://github.com/web-infra-dev/rspack" target="blank"><img src="https://assets.rspack.dev/rspack/rspack-banner.png" width="400" /></a> | [Examples](./rspack) | [Document](https://rspack.dev/) |
8+
| :---------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------: | :----------------------------------: |
9+
| [Rsbuild](https://github.com/web-infra-dev/rsbuild) | <a href="https://github.com/web-infra-dev/rsbuild" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" width="400" /></a> | [Examples](./rsbuild) | [Document](https://rsbuild.dev/) |
10+
| [Rspress](https://github.com/web-infra-dev/rspress) | <a href="https://github.com/web-infra-dev/rspress" target="blank"><img src="https://assets.rspack.dev/rspress/rspress-banner.png" width="400" /></a> | [Examples](./rspress/) | [Document](https://rspress.dev/) |
11+
| [Rsdoctor](https://github.com/web-infra-dev/rsdoctor) | <a href="https://github.com/web-infra-dev/rsdoctor" target="blank"><img src="https://assets.rspack.dev/rsdoctor/rsdoctor-banner.png" width="400" /></a> | [Examples](./rsdoctor/) | [Document](https://rsdoctor.dev/) |
12+
| [Rslib](https://github.com/web-infra-dev/rslib) | <a href="https://github.com/web-infra-dev/rslib" target="blank"><img src="https://assets.rspack.dev/rslib/rslib-banner.png" width="400" /></a> | [Examples](https://github.com/web-infra-dev/rslib/tree/main/examples) | [Document](https://lib.rsbuild.dev/) |
1313

1414
## How to Use
1515

16+
### Clone single example
17+
18+
To clone a single example, you can use the [gitpick](https://github.com/nrjdalal/gitpick) to clone a sub-directory from the current repository.
19+
20+
For example, to clone the `/rspack/basic` example, run the following command:
21+
22+
```bash
23+
# Clone the basic example
24+
npx gitpick https://github.com/rspack-contrib/rstack-examples/tree/main/rspack/basic
25+
26+
# Enter the basic example directory
27+
cd basic
28+
29+
# Install the dependencies
30+
pnpm i
31+
```
32+
33+
### Clone all examples
34+
35+
To try all examples, you can clone the current repository to your local.
36+
1637
1. First, clone the current repository to your local:
1738

1839
```bash

0 commit comments

Comments
 (0)