Finished installation page

MSUSEL · Jan 31, 2025 · 3e2744b · 3e2744b
1 parent 01f00d5
commit 3e2744b
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 156 deletions.
diff --git a/docs/developer-notes/getting-started.md b/docs/developer-notes/getting-started.md
diff --git a/docs/developer-notes/installation.md b/docs/developer-notes/installation.md
diff --git a/docs/developer-notes/setup.md b/docs/developer-notes/setup.md
@@ -0,0 +1,86 @@
+# Getting Started with PIQUE Visualizer
+
+Welcome to **PIQUE**! This guide will walk you through the steps to install, set up, and run the visualizer on your machine.
+
+## Prerequisites
+
+Make sure you have the following installed:
+
+- **[Node.js](https://nodejs.org/) (16.x or later)** – Required to run PIQUE Visualizer. Check with:
+  ```bash
+  node -v
+  ```
+- **npm** – Comes with Node.js, used for managing dependencies. Check with:
+  ```bash
+  npm -v
+  ```
+- **[Git](https://git-scm.com/downloads)** – Needed to clone the repository
+- **(Optional) Virtual Environment** – Useful for managing dependencies separately
+
+---
+
+## Installation
+
+Follow these steps to install the application:
+
+### Clone the Repository
+
+First, clone the repository to your local machine using Git:  
+```bash
+git clone https://github.com/MSUSEL/Pique-Lite.git
+```
+
+### Navigate to the Project Directory
+
+```bash
+cd Pique-Lite
+```
+
+### (Optional) Set up a Virtual Environment
+```bash
+# This example uses `venv` on Linux:
+python3 -m venv venv
+source venv/Scripts/activate
+```
+
+### Install Dependencies
+
+Run the following command to install the required dependencies:  
+```bash
+npm install
+```
+
+This will read the package.json file and install all necessary packages locally.
+
+## Running the Visualizer
+
+Once the installation is complete, you can start the visualizer:
+
+1. Start the development server:
+
+```bash
+npm run dev
+```
+
+2. Open your browser and navigate to the following URL (if it doesn’t open automatically):
+
+```bash
+http://localhost:
+```
+
+---
+
+## Next Steps
+
+Now that the PIQUE Visualizer is running, you’re ready to analyze your software quality results!
+
+- Explore the Using the Visualizer section for a detailed walkthrough of the tool's features.
+- Refer to the Input Schema page to understand how to prepare your JSON input files.
+
+
+
+
+
+
+
+
diff --git a/docs/developer-notes/system-requirements.md b/docs/developer-notes/system-requirements.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,48 +1,2 @@
 # Welcome to PIQUE
 
-## Overview
-
-The PIQUE Visualizer is a sophisticated React application designed to bring clarity and insight into software quality assessment. By visualizing PIQUE analysis results in a hierarchical tree display, it transforms complex JSON files into an intuitive and navigable interface. This tool is essential for developers, quality assurance professionals, and researchers who strive to understand and enhance software quality through detailed metrics and diagnostics.
-
-## Purpose
-
-Our mission with the PIQUE Visualizer is to simplify the interpretation of software quality results. We understand the challenges of parsing through dense JSON data. With this tool, users can easily navigate through quality scores, understand the impact of various factors on software quality, and make informed decisions to improve their projects.
-
-## Significance
-
-* Intuitive Visualization: Hierarchical tree displays make it easier to digest complex relationships and metrics.
-* Efficient Analysis: Quickly identify key quality aspects and factors affecting your software project.
-* Improved Decision Making: Visual insights aid in pinpointing areas for improvement and strategic planning.
-
-## Target Audience
-
-The PIQUE Visualizer is designed for:
-
-* Software Developers: To assess and improve code quality.
-* Quality Assurance Professionals: To visualize and interpret quality metrics.
-* Research Scholars: Engaged in software quality research, looking for tools to aid in their analysis.
-
-## Getting Started
-
-Dive into using the PIQUE Visualizer by visiting our Getting Started page. You'll find detailed instructions on installation, setup, and prerequisites.
-
-
-<!-- ## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
-
-```python {annotate: true}
-def hello_world():
-    # testing
-    print("Hello, World!")
-``` -->
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -78,9 +78,7 @@ nav:
   - Overview:
     - Introduction: overview/introduction.md
     - Quick Start: overview/quick-start.md
-  - Developer Notes:
-    - Getting Started: developer-notes/getting-started.md
-    - Installation: developer-notes/installation.md
+  - Developer Notes: developer-notes/setup.md
   - User Guide: 
     - Input Schema: 
       - Overview: user-guide/input-schema/input-schema.md