Skip to content

Commit

Permalink
Update README.md, Add all necessary information ( Final version )
Browse files Browse the repository at this point in the history
  • Loading branch information
emreozgenc committed Jun 2, 2022
1 parent 9b58bc6 commit 3e8f0d6
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
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 )

0 comments on commit 3e8f0d6

Please sign in to comment.