Timur Sağlam 4 rokov pred
rodič
commit
dc00ca6a03
1 zmenil súbory, kde vykonal 9 pridanie a 1 odobranie
  1. 9 1
      report-viewer/README.md

+ 9 - 1
report-viewer/README.md

@@ -1,4 +1,12 @@
-# report-viewer
+# JPlag Report Viewer
+
+The JPlag Report Viewer is a Vue 3 + Typescript standalone application that can be used to display the JSON files generated by the JPlag reporting. The application requires Node.js and npm to be installed on the system.
+
+Before the first run execute:
+
+- Install necessary dependencies by running `npm install` in the /report-viewer folder.
+- Start the application by running the `npm run serve` command in the /report-viewer folder.
+- The report viewer is now accessible in your browser under http://localhost:8080/JPlag/
 
 
 ## Project setup
 ## Project setup
 ```
 ```