Skip to content

Commit 2e62c71

Browse files
Add more details to introduction and update README.md
1 parent 330080c commit 2e62c71

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

tutorials/ai/prompt-scaffolding/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1-
This setup allows you to scaffold your own Java desktop app with a React-based
2-
UI.
1+
This setup allows you to scaffold a Java desktop app with JxBrowser for the
2+
webview, a React UI (with shadcn/ui), and Protobuf/gRPC for communication
3+
between Java and JavaScript.
34

45
## Prerequisites
56

67
- Java 17 or higher
78
- [Node.js](https://nodejs.org/en/download) 20.11.0 or higher
8-
- [Cursor](https://cursor.com/)
9-
- Claude 4 Sonnet
9+
- [Cursor](https://cursor.com/)
10+
- Claude 4 Sonnet
1011

1112
## How to use
1213

13-
To try it yourself, download the [`docs`](docs) directory and put it into an
14-
empty project.
14+
To try it yourself, download the [`docs`](docs) and [`template`](template)
15+
directories and put them into an empty project.
1516

16-
Then add the `architecture-overview.md` document to the context for a new
17-
project in Cursor, and ask the LLM to generate the app.
17+
Then add the [`architecture-overview.md`](docs/architecture-overview.md)
18+
document to the context for a new project in Cursor, and ask the LLM to
19+
generate the app.
1820

1921
![Paste the prompt in Cursor](img/paste-prompt-in-cursor.png)
2022

@@ -46,7 +48,10 @@ Then, in another terminal, launch the application itself:
4648
./gradlew run
4749
```
4850

49-
You should see the desktop app window with Shadcn (React) UI that allows viewing
51+
You should see the desktop app window with shadcn/ui (React) that allows viewing
5052
local files/folders and navigating through them:
5153

5254
![FileViewer](img/file-viewer.png)
55+
56+
After the application successfully started, you can remove the [`docs`](docs)
57+
and [`template`](template) directories.

0 commit comments

Comments
 (0)