Skip to content

fix(readme.md): reorder installation steps in README.md #851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jah-yee wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Open

fix(readme.md): reorder installation steps in README.md #851

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,13 @@ The best way to understand A2UI is to run the samples.
Open a new terminal window:

```bash
# Install and build the Markdown renderer
cd renderers/markdown/markdown-it
# Install and build the Web Core library (must be built first - markdown-it depends on it)
cd renderers/web_core
npm install
npm run build

# Install and build the Web Core library
cd ../../web_core
# Install and build the Markdown renderer
cd ../markdown/markdown-it
npm install
npm run build
Comment on lines +137 to 145
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better robustness and user experience, consider running the build commands for each package within a subshell (...). This prevents the cd command from changing the user's current directory and makes each step runnable independently from the project root. Chaining commands with && also ensures that subsequent commands only run if the previous ones succeed.

For example:

# Install and build the Web Core library (must be built first - markdown-it depends on it)
(cd renderers/web_core && npm install && npm run build)

# Install and build the Markdown renderer
(cd renderers/markdown/markdown-it && npm install && npm run build)


Expand Down