From 2efc60fa742dfb6e053e1847d0cb17d54c5b998e Mon Sep 17 00:00:00 2001 From: kvtalati Date: Sat, 30 Sep 2023 19:58:48 -0400 Subject: [PATCH] modify README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 83dc58a..bfdf383 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,25 @@ Text editors are something that we use everyday to perform everyday tasks. It's ## Purpose The idea behind this project is sort of like a sleeper PC build; where the computer itself is an old-fashioned 90s PC, but inside it packs the latest graphics cards and CPUs. In this way, this app uses the Metal Java Swing theme and the design is purposely understated. However, under the hood, one can build in Alexa integration, smart suggestions, text-to-speech, you name it. +## Compiling and Building Application +This is a Java application. Follow the steps below to compile and build the application. + Ensure that you have atleast JDK 11 installed. It can be installed here: https://www.oracle.com/java/technologies/downloads/#java8 + + In the root of your repo run the javac command , this will compile the application + To build the application you can run the java OpenNote + +This will allow you to run your application. + ## Screenshots ![Alt text](https://raw.githubusercontent.com/nich227/OpenNote/master/screenshot.PNG) +## TroubleShooting +Some common questions and troubleshooting: + Issues building and compiling: + - Check the PATH variable of your JDK, ensure that your path is set to the bin folder + - Ensure you have atleast JDK 11 or higher + - Compile and build within your IDE (Vscode or JetBrains is recommended) + - mvn compile: to run the maven compilation + ## Technical info Built in NetBeans 9.0 with JDK 11 \ No newline at end of file