mirror of
https://github.com/hensm/fx_cast.git
synced 2026-06-12 10:39:57 +00:00
Update README + add web-ext start script
This commit is contained in:
28
README.md
28
README.md
@@ -27,12 +27,38 @@ Only tested on Linux and macOS. mDNS library issue to be fixed. `mdns` only work
|
|||||||
### Instructions
|
### Instructions
|
||||||
|
|
||||||
````sh
|
````sh
|
||||||
git clone https://github.com/hensm/caster.git
|
git clone https://github.com/hensm/fx_cast.git
|
||||||
npm install
|
npm install
|
||||||
npm run build
|
npm run build
|
||||||
npm run install-manifest
|
npm run install-manifest
|
||||||
````
|
````
|
||||||
|
|
||||||
|
This will build the ext and app, outputting to dist/.
|
||||||
|
|
||||||
|
`dist/app/` contains the bridge binary and manifest with the path pointing that binary. `install-manifest` copies the manifest to the proper location (or adds its current location to the registry).
|
||||||
|
|
||||||
|
`dist/ext/` contains the built extension in the format `fx_cast-<version>.zip` in addition to the unpacked extension at `dist/ext/unpacked/`.
|
||||||
|
|
||||||
|
|
||||||
|
Watching ext changes and auto reload:
|
||||||
|
````sh
|
||||||
|
npm run watch --prefix ./ext
|
||||||
|
|
||||||
|
# In seperate terminal
|
||||||
|
npm run start --prefix ./ext
|
||||||
|
````
|
||||||
|
|
||||||
|
|
||||||
|
### Packaging
|
||||||
|
|
||||||
|
Packaging currently only possible on macOS:
|
||||||
|
|
||||||
|
````sh
|
||||||
|
npm run package
|
||||||
|
````
|
||||||
|
|
||||||
|
`dist/app/` contains the installer package: `fx_cast_bridge.pkg` (macOS). `dist/ext/` contains the built extension.
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
Testing requires geckodriver (or chromedriver for Chrome parity testing). See [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver#installation) installation instructions (ignore `npm install`).
|
Testing requires geckodriver (or chromedriver for Chrome parity testing). See [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver#installation) installation instructions (ignore `npm install`).
|
||||||
|
|||||||
@@ -2,7 +2,8 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "node build.js",
|
"build": "node build.js",
|
||||||
"package": "node build.js --package",
|
"package": "node build.js --package",
|
||||||
"watch": "node build.js --watch"
|
"watch": "node build.js --watch",
|
||||||
|
"start": "web-ext run -s ../dist/ext/unpacked/"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@babel/core": "^7.1.5",
|
"@babel/core": "^7.1.5",
|
||||||
|
|||||||
Reference in New Issue
Block a user