d42126051c
- Updated README and build_and_run.md to reflect the new project name: FilterView - Renamed window title in App.java from "Speed Graph" to "Filter View" - Completed project renaming for consistency across documentation and code
2.6 KiB
Build and Run Instructions for Filter-View Application
This guide explains how to build and run the Filter-View with Adjustable Raised Cosine Filter application on different platforms: Arch Linux, Ubuntu, and Windows.
Prerequisites
Before proceeding, ensure you have the following installed:
- Java Development Kit (JDK) 17 or higher
- Git (for cloning the repository)
Note
: You do not need to install Maven manually. The project includes the Maven Wrapper, which will handle everything.
Arch Linux
1. Install Dependencies
You can install the necessary dependencies using pacman:
sudo pacman -S jdk17-openjdk maven git
2. Clone the Repository and Build
git clone https://github.com/eric-waveletsolutions/filter-view.git
cd filter-view
./mvnw clean install
3. Run the Application
./mvnw javafx:run
4. Generate Javadocs
./mvnw clean install -Pfull-build
5. View Javadocs
Once generated, the Javadocs can be found in the target/apidocs/ directory. Open the index.html file in a browser:
firefox target/apidocs/index.html
Ubuntu
1. Install Dependencies
You can install the required packages using apt:
sudo apt update
sudo apt install openjdk-17-jdk maven git
2. Clone the Repository and Build
git clone https://github.com/eric-waveletsolutions/filter-view.git
cd filter-view
./mvnw clean install
3. Run the Application
./mvnw javafx:run
4. Generate Javadocs
./mvnw clean install -Pfull-build
5. View Javadocs
Once generated, the Javadocs can be found in the target/apidocs/ directory. Open the index.html file in a browser:
firefox target/apidocs/index.html
Windows
1. Install Dependencies
-
Install Java 17: Download and install the JDK from the Oracle website or using AdoptOpenJDK.
-
Install Maven: Download Maven from the Apache Maven website, extract it, and set it up in your system's PATH.
-
Install Git: Download and install Git from the Git website.
2. Clone the Repository and Build
Open the terminal (or Git Bash) and run:
git clone https://github.com/eric-waveletsolutions/filter-view.git
cd filter-view
mvnw.cmd clean install
3. Run the Application
mvnw.cmd javafx:run
4. Generate Javadocs
mvnw.cmd clean install -Pfull-build
5. View Javadocs
Once generated, the Javadocs can be found in the target/apidocs/ directory. Open the index.html file in your browser by navigating to the directory and opening the file.