Skip to content

Added a Compile Commands section and a Features/Contributing Tips sec… #2

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
AlanWang611 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added a Compile Commands section and a Features/Contributing Tips sec… #2

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
28 changes: 24 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,31 @@
## About
Text editors are something that we use everyday to perform everyday tasks. It's pretty unremarkable. But, what if we can make text editors do special things? What if we can customize a text editor to fit our needs? This is where OpenNote comes in. OpenNote is an open-sourced, crowd-sourced text editor where the sky is the limit.

## Purpose
Built in NetBeans 9.0 with JDK 11

## Usage
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.

## Screenshots
This is a Java Application. Follow the steps to run OpenNote:
1. Ensure you have Java 11 or later installed (https://www.oracle.com/java/technologies/downloads/#java8)
2. Download the latest release source code
3. Navigate to source directory
4. Compile: ```javac OpenNote.java```
5. Run: ```java OpenNote```
6. It should work now!

![Alt text](https://raw.githubusercontent.com/nich227/OpenNote/master/screenshot.PNG)

## Technical info
Built in NetBeans 9.0 with JDK 11
## Features
1. Customizable interface - visual theme, fonts, colors, and layouts
2. Keyboard shortcuts - Added quick shortcut keys for common actions
3. Cross platform - Runs on Windows, Mac, Linux, and more

## Contributing
Contributions are welcome and encouraged. Make sure you follow these guidelines:
1. Fork the repo and create a new branch
2. Add reasonable tests for functionality
3. Follow the existing code style
4. Document new code
5. Submit pull requests for review