Skip to content

Commit 42e6159

Browse files
authored
Merge pull request #443 from Hyperloop-UPV/control-station/update-electron-docs
docs: replace npm mentions with pnpm
2 parents 335b80c + b533526 commit 42e6159

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

electron-app/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ When running in development mode (unpackaged), the application creates temporary
2222

2323
- `config.toml.backup-{timestamp}` - Automatic backup files created when importing a configuration. These timestamped backups help recover previous configurations if needed.
2424

25-
- `binaries/` - Directory containing compiled backend executables for your platform. These are generated during the build process, when running `npm run build`.
25+
- `binaries/` - Directory containing compiled backend executables for your platform. These are generated during the build process, when running `pnpm run build`.
2626

27-
- `renderer/` - Directory containing built frontend views (control-station, ethernet-view). These are generated during the build process, when running `npm run build`.
27+
- `renderer/` - Directory containing built frontend views (control-station, ethernet-view). These are generated during the build process, when running `pnpm run build`.
2828

29-
- `dist/` - Build output directory containing compiled and packaged application files. Generated during build and distribution processes, when running `npm run dist`.
29+
- `dist/` - Build output directory containing compiled and packaged application files. Generated during build and distribution processes, when running `pnpm run dist`.
3030

3131
**Note**: These files and directories are created in the `electron-app/` directory root during development. In production (packaged) mode:
3232

@@ -54,24 +54,24 @@ Typical locations:
5454

5555
```
5656
# Install dependencies
57-
npm install
57+
pnpm install
5858
5959
# Build backend and frontends
60-
npm run build
60+
pnpm run build
6161
62-
# Run in development mode (you MUST run `npm run build` BEFORE!)
63-
npm start
62+
# Run in development mode (you MUST run `pnpm run build` BEFORE!)
63+
pnpm start
6464
```
6565

6666
## Build for production
6767

6868
This script creates distributables and executables.
69-
**Note**: You must run `npm run build` for this script to work correctly.
69+
**Note**: You must run `pnpm run build` for this script to work correctly.
7070

7171
```
72-
npm run dist:win # Windows
73-
npm run dist:mac # macOS
74-
npm run dist:linux # Linux
72+
pnpm run dist:win # Windows
73+
pnpm run dist:mac # macOS
74+
pnpm run dist:linux # Linux
7575
```
7676

7777
### macOS Requirements
@@ -85,14 +85,14 @@ sudo ipconfig set en0 INFORM 127.0.0.9
8585
## Available Scripts
8686

8787
```
88-
- `npm run build` - Build all frontend views and backend
89-
- `npm start` - Run application in development mode
90-
- `npm run dist` - Build production executable
91-
- `npm test` - Run tests
88+
- `pnpm run build` - Build all frontend views and backend
89+
- `pnpm start` - Run application in development mode
90+
- `pnpm run dist` - Build production executable
91+
- `pnpm test` - Run tests
9292
...and many custom variations (see package.json)
9393
94-
# Only works and makes sense after running `npm run dist`
95-
- `npm run asar:{platform}` - Shows .asar application package content for [win, linux, mac] platforms
94+
# Only works and makes sense after running `pnpm run dist`
95+
- `pnpm run asar:{platform}` - Shows .asar application package content for [win, linux, mac] platforms
9696
```
9797

9898
## Architecture

0 commit comments

Comments
 (0)