From 3e8f0d60fc1f011b56309f2b205d1ea44759592b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Emre=20=C3=96zgen=C3=A7?= Date: Fri, 3 Jun 2022 00:31:49 +0300 Subject: [PATCH] Update README.md, Add all necessary information ( Final version ) --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f622f05..5d485ad 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,23 @@ # SpellingBee -A repository which contains Visual Programming Assignment's project files. +A repository that contains Visual Programming Assignment's project files. + +# How to execute +You have two options to run the project. + +### Using Maven +`mvn clean javafx:run`

+This option might not work if you use a different Java version. + +### Using App class +You can use the App class to run the project like a regular Java project. + +### Warning +We are using Maven to manage dependencies. Please be sure all dependencies are installed before running the project. # Documents -You can find UML, use-case, and project report in ProjectReport.pdf +You can find UML, use-case, and project report in ProjectReport.pdf # Contributors - Emre Özgenç 1030510264 ( emreozgenc ) - Mehmet Kekeç 1030510209 ( mehmetkekec58 ) -- Nurullah Ataş 1030510178 ( nrllahh ) +- Nurullah Ataş 1030510178 ( nrllahh ) \ No newline at end of file