commit 810cf5cfe8037c5d59d7f86c9192e72fa7c29e73
author Antoine Musso <hashar@free.fr> Fri Jul 07 16:55:06 2023 +0200
committer Antoine Musso <hashar@free.fr> Fri Jul 07 17:08:40 2023 +0200
tree a6c23866b52861de9bf66c85dbafc355e79b300a
parent 49cc3330fea7355a840a3db89518c2f57af477f7

Improve README.md build instructions and more

I got a little confused as to setup the symlink since that is the first
time I encounter a polygerrit plugin. I went to remove some ambiguity
and give the full command to symlink the plugin package.json into the
Gerrit tree.

Additionally:
* stop refering to Resemble.JS version number in the README.md since
  it did not get bumped the last few times the library got upgraded.
* Remove Jack Zheng Github URL since it nowadays yields a 404.

Change-Id: Ifb18747a74308e5c69eafd46cecf7a1e52367b67

README.md

diff --git a/README.md b/README.md
index d29394d..4088abf 100644
--- a/README.md
+++ b/README.md
@@ -9,15 +9,25 @@
 
 ### Build
 
-1. Clone the package into `plugins` folder of `gerrit` repo or link the plugin folder to `gerrit/plugins` folder
-2. Override `plugins/package.json` with `external_package.json`, you can remove all `depDependencies` as they are not needed for the build (needed for running wct tests)
-3. Run `bazel build plugins/image-diff`
+The build requires to be done from an existing Gerrit tree. All commands below are relative to the root of a copy of Gerrit.
+
+1. Clone the `image-diff` repository into the `plugins` folder of the `gerrit` repo,
+   or link the `image-diff` plugin folder to `gerrit/plugins` folder.
+2. Override Gerrit `plugins/package.json` with the plugin package.json:
+```
+ln --symbolic --force image-diff/package.json plugins/package.json
+```
+
+You can remove all `depDependencies` from `plugins/package.json` as they are not needed for the build (they are only needed for running wct tests).
+
+3. run `bazel build plugins/image-diff`
 
 ## Highlight Mode
 
 ![Highlight example](assets/highlight-example.png)
 
-This mode uses the [Resemble.JS](https://github.com/HuddleEng/Resemble.js?files=1) (1.2.1) library in its development
+This mode uses the [Resemble.JS](https://github.com/HuddleEng/Resemble.js?files=1) library.
+
 The following features are included in this mode:
 
 * Percentage of difference between the images
@@ -51,6 +61,6 @@
 
 ## Authors
 
-* [Jack Zheng](https://github.com/JZ987)
+* Jack Zheng
 * Raeggin Williams
 * Kasper Nilsson