You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-7Lines changed: 54 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -52,14 +52,61 @@ For a detailed overview of the features and settings, please see the [Getting St
52
52
If you would like to help with development, but don't have experience coding, its very helpful to have users test a release candidate before actually publishing it to everyone. If you are interested in testing new versions see [this page](https://github.com/richardfrost/AdvancedProfanityFilter/wiki/Beta-Testing) for more information.
53
53
54
54
## Development
55
-
This project is written in TypeScript, and during the build/package process it will be converted to JS. Please see `package.json`'s scripts for more info on the process.
55
+
### Quick Start
56
+
After downloading/cloning the repository, run the following commands to get started:
56
57
57
-
Getting started
58
-
```
58
+
```sh
59
+
# Install dependencies
59
60
npm install
60
-
```
61
61
62
-
To Build the extension
63
-
```
64
-
npm run package
62
+
# Build the extension for the default target browser for local development
63
+
# See table below for supported targets
64
+
npm run build
65
65
```
66
+
Once the extension has been built, you can load the unpacked extension (found in `dist/`) in your browser.
| v3 | build |`npm run build:v3`| Development build for Manifest V3 |
92
+
| v2 | build |`npm run build:v2`| Development build for Manifest V2 |
93
+
| firefox | build |`npm run build:firefox`| Development build for Firefox |
94
+
| safari | build |`npm run build:safari`| Development build for Safari |
95
+
| safari | release |`npm run package:safari`| Official release for safari |
96
+
|| release |`npm run release:all`| Official relase for all targets |
97
+
98
+
### State files
99
+
The state files hold the details about the current build. These files are managed by `bin/prebuild.mjs`.
100
+
101
+
-`.build.json`
102
+
- Current development target details
103
+
- This is used for active development, and allows the developer to run simple commands such as `npm run build` to rebuild the project for the target specified in the file
104
+
-`.release.json`
105
+
- Current release target details
106
+
- Takes precedence over `.build.json`, but gets removed after release is finished
107
+
108
+
#### Details contained in state files:
109
+
-`config`: Overrides for the target
110
+
-`manifestVersion`: Manifest version from `src/static/manifest.json`
0 commit comments