Merge pull request #1931 from jplag/report-viewer/readme

Update report viewer readme

report-viewer/README.md

@@ -1,37 +1,52 @@
 # 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.
+The JPlag Report Viewer is a web application that can be used to display the zip file generated by JPlag. 
 
-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 dev` command in the /report-viewer folder.
-- The report viewer is now accessible in your browser under http://localhost:8080/
 
 ## Project setup
+The application requires Node.js and npm to be installed on the system.
 ```
 npm install
 ```
 
-### Compiles and hot-reloads for development
+### Run the development server
 ```
 npm run dev
 ```
 
-### Compiles and minifies for production
+### Compile and build
+There are different ways to build the report-viewer.
+
+The report viewer will be built and packaged with the cli in a jar file if built with the `with-report-viewer` profile:
+```
+mvn -Pwith-report-viewer clean package assembly:single
+```
+
+To build it in the standard way, without any base url, run:
 ```
 npm run build
 ```
 
-### Lints and fixes files
+For production builds (for example to host on GitHub Pages in a repository called `JPlag`) run:
 ```
-npm run lint
+npm run build:prod
 ```
+When hosting this build it will need to be accessible under `yourdomain.tld/JPlag/`.
 
-### Format files with prettier
+To build the demo version run:
 ```
-npm run format
+npm run build:demo
 ```
+Similar to the production build, this build will have `demo` as its base url.
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+
+## Contributing
+
+We're happy to incorporate all improvements to JPlag into this codebase. Feel free to fork the project and send pull requests. Please consider our guidelines for contributions.
+
+Before committing please run the following commands to ensure that the code is properly formatted and linted.
+```
+npm run format
+npm run lint
+```
+This can also be done automatically by the precommit hooks. They get automatically installed when running `npm install`.