Changes to update the build instructions (#28)

* changes to update the build instructions

readme.md

@@ -13,7 +13,7 @@ The assumption is then that the input is a sequence of images. The program outpu
 
 Prerequisites:
 ```
-sudo apt-get install -y libopencv-dev libyaml-cpp-dev libprotobuf-dev libprotoc-dev protobuf-compiler
+sudo apt-get install -y build-essential libopencv-dev libyaml-cpp-dev libprotobuf-dev libprotoc-dev protobuf-compiler
 ```
 Tested on Ubuntu 20.04.
 

src/python/netvlad/requirements.txt

@@ -1,3 +1,3 @@
 torch==1.13.1
 torchvision==0.14.1
-scipy==1.9.3
+scipy==1.10.0

src/viewer/README.md

@@ -1,14 +1,45 @@
 # Viewer
-This viewer should be used for debug purposes. Right now, you can only examine the cost matrix.
+This viewer should be used for debug purposes. In the viewer, you can:
+* Examine cost matrices that are stored in ".CostMatrix.pb" format.
+* Preview images in both sequences.
+* OnClick on the cost matrix preview the corresponding image pair.
+* Preview the matchign result, stored in ".MatchingResult.pb".
 
 ## Install
-Call from `src/viewer`:
+Make sure you have installed **npm** and **node** of the correct version.
+Use **nvm** to install them. For details, check here https://github.com/nvm-sh/nvm
 
-`./copy_protos.sh`
-`npm install d3 @types/d3 protobufjs`
+Install nvm
+```bash
+    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
+``` 
 
+Install **node** at curently tested version:
+```bash
+nvm install 20.9
+```
+
+Upgrade **npm** respectively:
+```bash
+npm update
+```
+Check the version:
+```bash
+npm --version
+```
+if you see `10.1.0` you are good to go.
+Copy the proto definitions to be able to use them in the viewer.
+```bash
+./copy_protos.sh
+```
+Install all the necessary nodes with proper versions through:
+```bash
+npm install
+```
 
-## Use
-Call from the terminal and load any `*.CostMatrix.pb`
 
-`npm run start`
+## Use
+To run the viewer, call 
+```bash
+npm run start
+```

src/viewer/copy_protos.sh

@@ -1 +1,2 @@
-cp ../localization_protos.proto public/
+cp ../localization_protos.proto public/
+echo "Protos were copied"