-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md, Add all necessary information ( Final version )
- Loading branch information
1 parent
9b58bc6
commit 3e8f0d6
Showing
1 changed file
with
16 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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` <br /><br /> | ||
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 ) |