diff --git a/README.md b/README.md index 28f48f9..421e9ee 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,10 @@ Player statuses achievable: # How to run +### Prerequesites +- Atleast Java 25 JRE +- Apache Maven in case of source code compilation. + ### Source code compilation Clone the repository: `git clone https://git.ntnu.no/danieskj/Mappevurdering-IDATT2003`.
Navigate to the newly cloned folder.
@@ -117,6 +121,63 @@ This includes: The application saves player and gamestate in the corresponding folders under the name `storage.json`.
This file can be removed via. the scripts attached to each Release in the `Releases` tab. +# Usage +### Initial launch +- User may type in their player name. +- If none found, fill out the rest of the fields for initializing the player. +- Choose .csv stock file with proper format or use the predefined checkbox. + +### Default UI-Walkthrough +- Header + - Contains often sort menu on the left and searchbar centered. +- Navigation (Left bar) + - Name of current view. + - Clickable buttons for current view. + - Home screen & Previous page button. + - Advance to Next Week button. +- Toolbar + - Information display. + - Balance, week number, player status, Net worth. + - Account button & Quit button. +- Menu (Right pop-up bar) + - Displays on account button click. + - Player relevant navigation. + - Portfolio button. + - Transactions (Archive) button. + +### Exchange View +- User can browse, sort and search after stocks. +- Stocks are given with ticker, company name, latest price & price changes. +- User can sort after gainers or loosers of the current week, or stocks with new news. +- Stocks with white pulsating glow effect indicates new news in their newspaper. +- Interaction with stocks to go to their view. + +### Stock View +- Navigation: Newspaper button to see news. +- Content: + - Graph of the stock price evolution. + - Display with values on price evolution and holdings summarized. + - Buy menu with live calculations. + - Sell button which redirects to Portfolio with focus on current stock shares. + +### Portfolio View +- Displays relevant portfolio information & player statistics. +- "Finish game" button to finish the game and get a summary. +- Overview of current holdings and their returns. +- Sorting & searching capability by relevant information. +- Ability to sell holding instances. +- Ability to press the share to get redirected to the stock view. + +### Transaction Archive View +- Overview of all transactions made all time. +- Detailed information about each transaction. +- Sorting & searching capability by relevant information. + +### Game Finish +- Displays important statistics throught the playthrough. +- Summarizes profits. +- Deletes current player from storage. + # Guide to tests Testing follows the default AAA model (Arrange, Act, Assert).