Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add running steps, new intro
  • Loading branch information
pawelsa authored May 26, 2026
1 parent aaf118f commit 15fe2b2
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The exam of IDATT2003, "Programming 2" subject.
<!--toc:end-->

# Summary
The game 'Millions', simulates a digital marketplace for buying and selling stocks. The player follows an evolving market with the goal to get as rich as possible. It's up to the players mindset to play it safely, or gambling away with going all in.
Millions is a stock trading simulation game where players navigate a dynamic digital market to build as much wealth as possible. Play it safe with careful investments, or take high-risk gambles for the chance at enormous returns.

What you can expect from the game:
- Buying stocks
Expand Down Expand Up @@ -102,6 +102,11 @@ Navigate to the newly cloned folder. <br>
Run command: `mvn clean javafx:run`.

### Executable variants

> [!TIP]
> Try running the "fat jar" solution as the primary solution. <br>
> In case of malfunction, process to the other methods.
Navigate to the **Releases** tab in Github and press the latest release. <br>
Downloadable configurations for different operating systems should be available. <br>
Download and decompress the downloaded folder using any .ZIP tool alternative. <br>
Expand All @@ -112,8 +117,11 @@ Alternatively, a "fat jar" (Jar including all dependencies packaged together) is
This solution seems to work on some computers, but JavaFX is often found problematic.

> [!IMPORTANT]
>Due to missing testing ability. only **.AppImage** and **.exe** are compiled correspondingly for Linux and Windows machines.
>
> Due to missing testing ability. only **.AppImage** and **.exe** are compiled correspondingly for Linux and Windows machines.
>
> Windows:
> Microsoft Defender may be angry becuase of unsigned executables. Try running it as administrator.
>
> Linux:
> In case of executable not working, try starting it through the command line: `./Millions`. <br>
> If execution fails, try making the file a executable: `chmod +x Millions` and running again. <br>
Expand Down

0 comments on commit 15fe2b2

Please sign in to comment.