add: README

FahimFBA · Mar 26, 2023 · 7b46e50 · 7b46e50
1 parent 240f53f
commit 7b46e50
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+# Number Guessing Game
+
+This is a simple number guessing game. The computer will pick a random number between 1 and 100. The player will then try to guess the number. After each guess, the computer will tell the player if the guess is too high or too low. The player wins if they can guess the number within 1 to 4, and the user has to detect the correct number within 2 attempts.
+
+**The updated and the default branch is the `production` branch.**
+
+## Some screenshots
+
+![Main Screen](image/1.png)
+
+![User Screen](image/2.png)
+
+![Verdict Screen Win](image/3.png)
+
+![Verdict Screen Lose](image/4.png)
+
+
+## How to run
+
+1. Clone the repository
+2. You can simply run the game by launching the `jar` file. You can find the `jar` file in the `javafx-guessing-number-game\javafx-guessing-number-game\out\artifacts\GuessingNumberGame_jar` directory.
+3. If you want to see the code and run it, you can open the project in IntelliJ IDEA. You can find the project in the `javafx-guessing-number-game\javafx-guessing-number-game` directory.
+4. This contains three java classes. The `Main` class is only for building the artifact.
+5. The main class is the `MainGameScreen` class. That has also been added to the `pom.xml` file.
+6. THe secondary class is the `VerdictScreen` class which contains the output result screen.
+
+## How to play
+
+* Simple download the [jar](out/artifacts/GuessingNumberGame_jar/GuessingNumberGame.jar) file and run it.
+
diff --git a/image/1.png b/image/1.png
diff --git a/image/2.png b/image/2.png
diff --git a/image/3.png b/image/3.png
diff --git a/image/4.png b/image/4.png