update docs to alleviate issues with legacy build vs new build (#120)
This commit is contained in:
@@ -1,3 +1,9 @@
|
||||
# This repository is currently migrating the build process
|
||||
|
||||
We are currently migrating from using [gulp](https://gulpjs.com/) -> [webpack](https://www.google.com/search?q=webpack&oq=webpack&aqs=chrome.0.69i59l3j69i60l3j69i61l2.1368j0j4&sourceid=chrome&ie=UTF-8) for asset bundling. The currently published build will be left in place until this is complete
|
||||
|
||||

|
||||
|
||||
## Pre-requisites
|
||||
|
||||
- node v11.15.0
|
||||
@@ -12,3 +18,11 @@ This will allow you to run varios tasks
|
||||
|
||||
In devmode you can open [local remote devtools](http://localhost:8000)
|
||||

|
||||
|
||||
## Development instructions
|
||||
|
||||
```
|
||||
nvm use
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
@@ -64,7 +64,7 @@ jsxhint --jsx-only .
|
||||
|
||||
There is a precommit hook that lints the code before commiting the changes.
|
||||
|
||||
### Load unpacked in Chrome
|
||||
### Load unpacked in Chrome (current in chrome store)
|
||||
|
||||
1. Clone repository to disk
|
||||
2. Remove `browser_specific_settings` key from manifest.json (only necessary for firefox)
|
||||
@@ -73,8 +73,12 @@ There is a precommit hook that lints the code before commiting the changes.
|
||||
5. Click `Load unpacked extension...`
|
||||
6. Select repository directory
|
||||
|
||||

|
||||
|
||||
### Troubleshooting
|
||||
|
||||
Check for errors by inspecting the extension.
|
||||
|
||||

|
||||
|
||||
The extension is going through a refactor, the new build [instructions are here](./DEVELOPMENT.md)
|
||||
|
||||
BIN
screenshots/load-repo-folder.png
Normal file
BIN
screenshots/load-repo-folder.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 114 KiB |
BIN
screenshots/repo-build.png
Normal file
BIN
screenshots/repo-build.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 127 KiB |
Reference in New Issue
Block a user