Skip to content

Included Compile/Build Commands and Troubleshooting Tips in README. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kvtalati wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Included Compile/Build Commands and Troubleshooting Tips in README. #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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