diff options
| author | Ajay <[email protected]> | 2023-05-10 15:09:27 -0400 |
|---|---|---|
| committer | Ajay <[email protected]> | 2023-05-10 15:09:27 -0400 |
| commit | 86498eb39996f23c714813626acf7508eaa135d9 (patch) | |
| tree | 618cbebfcdf6eb975cfb16899801d71a53df2a1e /README.md | |
| parent | 92fabdf37a9f8d1e64616dadd245ff8449f629e6 (diff) | |
| download | SponsorBlock-86498eb39996f23c714813626acf7508eaa135d9.tar.gz SponsorBlock-86498eb39996f23c714813626acf7508eaa135d9.zip | |
Add submodule build instructions to readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 16 insertions, 4 deletions
@@ -62,17 +62,29 @@ You can read the API docs [here](https://wiki.sponsor.ajay.app/index.php/API_Doc You must have [Node.js 16](https://nodejs.org/) and npm installed. -1. Copy the file `config.json.example` to `config.json` and adjust configuration as desired. +1. Clone with submodules + +```bash +git clone https://github.com/ajayyy/SponsorBlock --recurse-submodules=yes +``` + +Or if you already cloned it, pull submodules with + +```bash +git submodule update --init --recursive +``` + +2. Copy the file `config.json.example` to `config.json` and adjust configuration as desired. - You will need to repeat this step in the future if you get build errors related to `CompileConfig`. This can happen for example when a new category is added. -2. Run `npm install` in the repository to install dependencies. +3. Run `npm install` in the repository to install dependencies. -3. Run `npm run build:dev` (for Chrome) or `npm run build:dev:firefox` (for Firefox) to generate a development version of the extension with source maps. +4. Run `npm run build:dev` (for Chrome) or `npm run build:dev:firefox` (for Firefox) to generate a development version of the extension with source maps. - You can also run `npm run build` (for Chrome) or `npm run build:firefox` (for Firefox) to generate a production build. -4. The built extension is now in `dist/`. You can load this folder directly in Chrome as an [unpacked extension](https://developer.chrome.com/docs/extensions/mv3/getstarted/#manifest), or convert it to a zip file to load it as a [temporary extension](https://developer.mozilla.org/en-US/docs/Tools/about:debugging#loading_a_temporary_extension) in Firefox. +5. The built extension is now in `dist/`. You can load this folder directly in Chrome as an [unpacked extension](https://developer.chrome.com/docs/extensions/mv3/getstarted/#manifest), or convert it to a zip file to load it as a [temporary extension](https://developer.mozilla.org/en-US/docs/Tools/about:debugging#loading_a_temporary_extension) in Firefox. ### Developing with a clean profile and hot reloading |