Skip to content

Commit 32ebb43

Browse files
authored
Merge pull request #16 from atomic14/feature/better-install-instrutions
Better setup instructions in README
2 parents 26b8748 + ac4f900 commit 32ebb43

1 file changed

Lines changed: 21 additions & 4 deletions

File tree

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,14 +84,31 @@ Your support helps maintain and improve this tool for the entire community!
8484
- Real-time connection status with visual indicators
8585
- Professional footer with project links
8686

87+
88+
89+
## Using the App: Live vs. Local
90+
91+
Most users do **not** need to run this project locally! For general use, simply visit the live site:
92+
93+
- **[web-serial-plotter.atomic14.com](https://web-serial-plotter.atomic14.com)**
94+
95+
You only need to follow the local setup instructions below if you want to contribute, develop new features, or test changes to the codebase.
96+
8797
## Quick Start (development)
8898

89-
Prerequisites:
99+
### Prerequisites
90100

91-
- Node.js 18+ (LTS recommended)
92-
- A Chromium‑based browser that supports the Web Serial API (Chrome, Edge, Opera)
101+
- **Node.js 20.19+ or 22.12+** (required by Vite; older versions will not work)
102+
- To check your version, run:
103+
```bash
104+
node --version
105+
```
106+
- If your version is lower than 20.19.0, [download the latest Node.js here](https://nodejs.org/en/download) and install it.
107+
- For upgrade instructions, see the [official Node.js documentation](https://nodejs.org/en/download/package-manager/).
108+
- **npm** (comes with Node.js)
109+
- **A Chromium‑based browser** that supports the Web Serial API (Chrome, Edge, Opera)
93110

94-
Install and run:
111+
### Install and run
95112

96113
```bash
97114
npm install

0 commit comments

Comments
 (0)