commit 29573c2a1734534730bafa1b31202b28b6401fec
parent 2adbc48a64bc6263e8c75548716da3325c8587f6
Author: Michael Neuper <73108749+michaelneuper@users.noreply.github.com>
Date: Fri, 15 Jul 2022 13:07:06 +0200
Merge branch 'main' of https://github.com/michaelneuper/librejack
Diffstat:
| M | README.md | | | 32 | ++++---------------------------- |
1 file changed, 4 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
@@ -12,30 +12,9 @@ Before you begin, ensure you have met the following requirements:
* [Java](https://www.java.com/en/download/) installed on your system.
* Have a Windows/Linux/Mac machine..
-<!--
-## Installing <project_name>
+## Installing *librejack*
-To install <project_name>, follow these steps:
-
-Linux and macOS:
-```
-<install_command>
-```
-
-Windows:
-```
-<install_command>
-```
-## Building from source
-
-To use <project_name>, follow these steps:
-
-```
-<usage_example>
-```
-
-Add run commands and examples you think users will find useful. Provide an options reference for bonus points!
--->
+Download and run the `.jar ` file from the [releases tab](https://github.com/michaelneuper/librejack/releases)
## Directories
+ 'docs' contains documentation about the program
@@ -43,10 +22,6 @@ Add run commands and examples you think users will find useful. Provide an optio
+ 'nbproject' contains netbeans metadata about the project
+ 'src' contains the source files
-## TODOS
-+ Add stats
-+
-
## License
-This project uses the following license: [GPL v3](https://github.com/michaelneuper/librejack/blob/main/LICENSE.txt).
+This project uses the following license: [GPL v3](https://github.com/michaelneuper/librejack/blob/main/LICENSE.txt).
+\ No newline at end of file
