thePR0M3TH3AN/bitvid
1
0 Fork 0
mirror of https://github.com/PR0M3TH3AN/bitvid.git synced 2026-11-06 21:02:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: align build instructions and lint scope with codebase behavior

Browse Source 
Updates CONTRIBUTING.md and README.md to accurately reflect that:
- `npm start` builds to and serves the `dist/` directory.
- `npm run format` targets CSS, HTML, MD, and config (not JS logic).
- `npm run lint` targets styles, tokens, and hex codes (no ESLint).
- Manual build steps should serve `dist` via `npx serve dist`.

Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
google-labs-jules[bot]andPR0M3TH3AN committed 2026-02-01 16:37:07 +00:00
1 parent f68c407771
commit a3cc4a7456
2 files changed
+7 -6
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+3 -3
View File
@@ -164,13 +164,13 @@ To run **bitvid** locally:
http://localhost:3000
```
_Note: If you prefer manual steps, you can run `npm run build` followed by `npx serve` or `python -m http.server 8000`._
_Note: If you prefer manual steps, you can run `npm run build` followed by `npx serve dist`._
#### Quick Reference
- **Run unit tests**: `npm run test:unit`
- **Format code**: `npm run format`
- **Lint code**: `npm run lint`
- **Format code**: `npm run format` (CSS, HTML, MD, Config)
- **Lint code**: `npm run lint` (Styles, Tokens, Hex - no JS logic)
### Dev Container