docs: add detailed build instructions for AMO source review

Assisted-by: Claude Code
Signed-off-by: Avinal Kumar <avinal.xlvii@gmail.com>
This commit is contained in:
2026-04-28 00:38:24 +05:30
parent 5211fa1f8f
commit fce169f3f7
+23 -2
View File
@@ -50,12 +50,33 @@ Press **Ctrl+Space** to open the search overlay on any page.
## Building ## Building
### Requirements
- **OS**: Any platform that supports Node.js (Linux, macOS, Windows)
- **Node.js**: v18 or later — [install instructions](https://nodejs.org/)
- **npm**: comes bundled with Node.js
### Build steps
```bash ```bash
git clone https://github.com/avinal/sciezka.git
cd sciezka
npm install npm install
npm run build # one-time build npm run build
npm run watch # rebuild on file changes
``` ```
`npm run build` runs `node build.mjs`, which uses [esbuild](https://esbuild.github.io/) to compile three TypeScript entry points (`src/background.ts`, `src/content.ts`, `src/sciezka.ts`) into bundled JavaScript files in the `dist/` directory. No minification or obfuscation is applied.
The built extension files are:
- `dist/background.js` — background service worker
- `dist/content.js` — content script
- `dist/sciezka.js` — search UI logic
Other commands:
- `npm run watch` — rebuild on file changes
- `npm run typecheck` — run TypeScript type checking
- `npm run lint` — validate extension with web-ext
### Packaging for Firefox ### Packaging for Firefox
To create a `.zip` (which Firefox also accepts as `.xpi`) for sideloading: To create a `.zip` (which Firefox also accepts as `.xpi`) for sideloading: