Skip to content

Commit

Permalink
Added proper contnt on REDME.md
Browse files Browse the repository at this point in the history
  • Loading branch information
5amad committed Apr 12, 2022
1 parent a9d43dc commit c34859e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
Binary file added .res/occupied-cursor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# occupied_cursor
# Occupied Cursor

## Description
**Occupied Cursor** is a personal project where the goal is to occupy the cursor automatically. The tool is not necessarily a very useful tool but it does exactly what the name suggests it does. The tool is created using **Java** & [**JavaFX**](https://openjfx.io/).

## Preview
![occupied-cursor preview](.res/occupied-cursor.png)
## Building
### You can download the project binary from [here](/releases)
1. To build the project you will nead [Maven](https://maven.apache.org/)
1.1 Download the project from github `git clone https://github.com/suddin0/occupied_cursor`
1.2 Go to the root of the project `cd occupied_cursor`
1.3 Run the project `mvn clean javafx:run`
1.4 **OR** build the project using [jlink](https://docs.oracle.com/en/java/javase/11/tools/jlink.html) using the following command `mvn clean javafx:jlink`

A program that helps you occupy your cursor and other inputs

0 comments on commit c34859e

Please sign in to comment.