Skip to content

Commit d1d4b5d

Browse files
Update READMEs for lit samples with build instructions (#259)
* docs: update READMEs for lit samples with build instructions * docs: consolidate running instructions in lit sample READMEs
1 parent b8850ad commit d1d4b5d

File tree

2 files changed

+40
-8
lines changed

2 files changed

+40
-8
lines changed

samples/client/lit/contact/README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,23 @@ This is a UI to generate and visualize A2UI responses.
88

99
## Running
1010

11-
1. Install the dependencies: `npm i`
12-
2. Run the [A2A server](../../../agent/adk/contact_lookup/)
13-
3. Run the dev server: `npm run dev`
14-
4. Open http://localhost:5173/
11+
This sample depends on the Lit renderer. Before running this sample, you need to build the renderer.
12+
13+
1. **Build the renderer:**
14+
```bash
15+
cd ../../../renderers/lit
16+
npm install
17+
npm run build
18+
```
19+
20+
2. **Run this sample:**
21+
```bash
22+
cd - # back to the sample directory
23+
npm install
24+
```
25+
26+
3. **Run the servers:**
27+
- Run the [A2A server](../../../agent/adk/contact_lookup/)
28+
- Run the dev server: `npm run dev`
29+
30+
After starting the dev server, you can open http://localhost:5173/ to view the sample.

samples/client/lit/shell/README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,23 @@ This is a UI to generate and visualize A2UI responses.
88

99
## Running
1010

11-
1. Install the dependencies: `npm i`
12-
2. Run the [A2A server](../../../agent/adk/restaurant_finder/)
13-
3. Run the dev server: `npm run dev`
14-
4. Open http://localhost:5173/
11+
This sample depends on the Lit renderer. Before running this sample, you need to build the renderer.
12+
13+
1. **Build the renderer:**
14+
```bash
15+
cd ../../../renderers/lit
16+
npm install
17+
npm run build
18+
```
19+
20+
2. **Run this sample:**
21+
```bash
22+
cd - # back to the sample directory
23+
npm install
24+
```
25+
26+
3. **Run the servers:**
27+
- Run the [A2A server](../../../agent/adk/restaurant_finder/)
28+
- Run the dev server: `npm run dev`
29+
30+
After starting the dev server, you can open http://localhost:5173/ to view the sample.

0 commit comments

Comments
 (0)