Merge branch 'feature/other-cosmetics-updates' into 'main'

Other cosmetics updates

See merge request belle2/software/display!5

Author: GiacomoXT

README.md

@@ -1,33 +1,18 @@
 # Belle II Event Display with Phoenix - GSoC 2023
 
 This Angular CLI web app displays Belle II events using Phoenix, a TypeScript-based event display framework.
-<br>
-The web app has been deployed and can be accessed through [display.belle2.org](https://display.belle2.org)
-
-In order to run the application on your local machine, please perform the following steps.
-<br>
-## Prerequisites
 
-1. Install Node.js and NPM on your system. You can download the latest version of Node.js from the [official website](https://nodejs.org/en/download/).
-2. Install Angular CLI globally by running the command `npm install -g @angular/[email protected]`. This command will install the latest version of Angular CLI on your system.
+The web app can be accessed through [display.belle2.org](https://display.belle2.org).
 
-## How to Run
-
-1. Clone this repository to your local machine
-```git clone [email protected]:belle2/display.git```
-2. Change the current directory into the cloned folder
-```cd display```
-3. Run `npm install` to install the necessary dependencies
-4. Run `npm start` or `ng serve` to start the development server
-5. Navigate to `http://localhost:4200/` in your web browser to view the app
+In order to run the application on your local machine, please refer to the the [documentation](https://display.belle2.org/documentation/developer/installation.html).
 
 ## About the App
 ![image](https://github.com/HieuLCM/GSoC2023_Belle2/assets/88785267/dc08313f-03a9-4832-9713-123b554b0a10)
 
-The web application serves as a tool that allows scientists and physicists to import events from mdst `.root` files, which contain data, and then view them directly in a web browser. By leveraging the Phoenix framework and adding custom features, the application provides a user-friendly environment for event display, complete with intuitive user interface controls.
-
+The web application serves as a tool that allows physicists and non-physicists to import Belle II events from `.root` files, containing either collisions or simulated data, and view them directly in a web browser. By leveraging the Phoenix framework and adding custom features, the application provides a user-friendly environment for event display, complete with intuitive user interface controls.
+<br>
 For more detailed instructions on how to use and develop the app, please refer to the [documentation](https://display.belle2.org/documentation).
 
-*The documentation is created using Sphinx and its source file is located in the `docs/` folder.*
+The documentation is created using Sphinx and its source file is located in the [`docs/` folder](https://github.com/belle2/display/tree/main/docs).
 
-### Le Cong Minh Hieu - GSoC 2023
+### Le Cong Minh Hieu, The Belle II Collaboration - Developed as part of the [Google Summer of Code 2023](https://hepsoftwarefoundation.org/gsoc/blogs/2023/blog_Belle2_HieuLeCongMinh.html)

docs/source/conf.py

@@ -13,7 +13,7 @@
 project = 'Belle II Event Display with Phoenix'
 copyright = '2023, Hieu Le Cong Minh'
 author = 'Hieu Le Cong Minh'
-release = '0.1'
+release = 'v0.0.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

src/app/detector/detector.component.html

@@ -20,8 +20,8 @@
 </app-ui-menu-wrapper>
 <app-phoenix-menu [rootNode]="phoenixMenuRoot"></app-phoenix-menu>
 <div class="info">
-    <h5><b>Le Cong Minh Hieu</b></h5>
-    <p>Belle II Detector</p>
+    <h5><b>Le Cong Minh Hieu, The Belle II Collaboration</b></h5>
+    <p>Belle II Detector, v0.0.0</p>
     <p>GSoC 2023</p>
 </div>
 <a id="mainLogo" class="main-logo fixed-top p-2 mx-auto mt-2" routerLink="/">

src/app/event-display/event-display.component.html

@@ -21,8 +21,8 @@
 <app-embed-menu></app-embed-menu>
 <app-phoenix-menu [rootNode]="phoenixMenuRoot"></app-phoenix-menu>
 <div class="info">
-    <h5><b>Le Cong Minh Hieu</b></h5>
-    <p>Belle II Event Display with Phoenix</p>
+    <h5><b>Le Cong Minh Hieu, The Belle II Collaboration</b></h5>
+    <p>Belle II Event Display, v0.0.0</p>
     <p>GSoC 2023</p>
 </div>
 <a id="mainLogo" class="main-logo fixed-top p-2 mx-auto mt-2" routerLink="/">

src/app/home/home.component.html

@@ -1,7 +1,7 @@
 <div class="container">
     <div class="pricing-header p-3 pt-md-5 pb-md-4 text-center">
         <img src="assets/images/logo.png" class="logo mb-4" alt="" />
-        <p class="lead">Welcome to the Belle II Event Display with Phoenix</p>
+        <p class="lead">Welcome to the Belle II Event Display with Phoenix - v0.0.0</p>
     </div>
 
     <div class="row centered">
@@ -40,9 +40,12 @@ <h5 class="card-title">Detector</h5>
 </div>
 
 <footer>
-    <p>Google Summer of Code 2023</p>
+    <p>Le Cong Minh Hieu, The Belle II Collaboration</p>
     <p>
-        <a href="https://github.com/belle2/display"> GitHub </a> -
+        Developed as part of the <a href="https://hepsoftwarefoundation.org/gsoc/blogs/2023/blog_Belle2_HieuLeCongMinh.html"> Google Summer of Code 2023 </a>
+    </p>
+    <p>
+        <a href="https://github.com/belle2/display/"> GitHub </a> -
         <a href="https://display.belle2.org/documentation/">
             Documentation
         </a>