Skip to content

Improved README readability #72

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
samuelgirmametaferia wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improved README readability #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1434807
Update README.md
samuelgirmametaferia Nov 30, 2025
a6ff00f
Fix capitalization in Valdi description
samuelgirmametaferia Nov 30, 2025
272a1d4
Update INSTALL.md with Windows support note
samuelgirmametaferia Nov 30, 2025
2000e19
Merge branch 'main' into main
clholgat May 13, 2026
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ The [`apps/`](./apps) directory contains runnable examples:
| [cli_example](./apps/cli_example) | Building a Valdi CLI application |
| [benchmark](./apps/benchmark) | Performance benchmarks |

## Why Choose Valdi?
## Why Valdi?
Copy link
Copy Markdown
Collaborator

@clholgat clholgat May 13, 2026

Choose a reason for hiding this comment

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

Leave the header as is


Valdi is a cross-platform UI framework designed to solve the fundamental problem of cross-platform development: velocity vs. runtime performance. For 8 years, it has powered a large portion of Snap's production apps.
Copy link
Copy Markdown
Collaborator

@clholgat clholgat May 13, 2026

Choose a reason for hiding this comment

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

Leave this as is.

Valdi is a cross-platform UI framework designed to solve the fundamental problem of cross-platform development: Velocity vs. Runtime Performance. For 8 years, it has powered a significant portion of Snap's production apps.

### True Native Performance

Expand Down
8 changes: 8 additions & 0 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ This guide will help you set up your development environment and get started wit
### Linux
No prerequisites! The Valdi CLI will install everything you need.

> [!IMPORTANT]
> Windows is not currently supported. Please wait for upcoming updates!
Copy link
Copy Markdown
Collaborator

@clholgat clholgat May 13, 2026

Choose a reason for hiding this comment

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

You can leave this at just "Windows is not currently supported"



### All Platforms
That's it! The `valdi dev_setup` command handles all other dependencies automatically, including:
- Homebrew (macOS)
Expand All @@ -33,6 +37,10 @@ That's it! The `valdi dev_setup` command handles all other dependencies automati
npm install -g @snap/valdi
```

> [!NOTE]
> During installation, you might see warnings about deprecated packages. These can usually be ignored!
Copy link
Copy Markdown
Collaborator

@clholgat clholgat May 13, 2026

Choose a reason for hiding this comment

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

Suggested change
> During installation, you might see warnings about deprecated packages. These can usually be ignored!
> During installation, you might see warnings about deprecated packages. These can be ignored!



### 2. Set Up Your Development Environment

```bash
Expand Down
Loading