From 0c23bf815620e76fb17fcb903750606333922836 Mon Sep 17 00:00:00 2001 From: Bam_boogie <65554208+Kudzmat@users.noreply.github.com> Date: Tue, 21 Jan 2025 15:50:27 +0200 Subject: [PATCH] Create how-to-guide.md Created How To Guide --- Docs/how-to-guide.md | 67 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 Docs/how-to-guide.md diff --git a/Docs/how-to-guide.md b/Docs/how-to-guide.md new file mode 100644 index 0000000..7a96abc --- /dev/null +++ b/Docs/how-to-guide.md @@ -0,0 +1,67 @@ +# How To Be A Shot Geek + +If you're reading this, it likely means you consider yourself a "shot sicko." You're not satisfied with just hearing about how great the players +from the 90s were; you want to see the data, analyze the trends, and compare them with what you observe today. Our product, ShotGeek, will help +you do just that and more. This guide will show you how the app operates and how to use its various features. Today, you become a Shot Geek! + +--- + +![Screenshot of ShotGeek landing page](https://github.com/user-attachments/assets/9584108e-5d56-4d7c-b9c6-18e39d65f761) + +--- + +## 1. How to Find a Player Page +To find a specific player’s page: +- Enter the **full name** of the player into the search bar. +- Avoid entering only a first name or making typos, as this may lead to incorrect results or an error page. + +**Example**: +To find Charles Barkley's page, enter `"Charles Barkley"` into the search bar. + +![Charles Barkley player page](https://github.com/user-attachments/assets/0c2a0d55-a69a-4f15-bad9-219562cfa36f) + + +Once on the player page: +- You can view the player’s **career stat totals**. +- For deeper analysis, scroll to the bottom of the page: + - Use the dropdown menu to view detailed **tables** for various statistics. + ![Table options](https://github.com/user-attachments/assets/aa65f830-ccba-40fd-9cf3-4ea0c53420ff) + + - Select a career category (regular season, playoffs etc.) and a stat category from the dropdown menu to view a **graph** visualizing the data. + ![Graph options](https://github.com/user-attachments/assets/1e319c92-a2be-494b-9b1a-5ddd426708f4) + +--- + +## 2. How to Change a Player Card +To change Player 1 or Player 2's card: +- Enter the **full name** of the player into the search bar above the respective player card. +- You can only change **one player card at a time**. +- Be sure to use the correct spelling—partial names or typos may result in incorrect results or an error page. +![Changing player card](https://github.com/user-attachments/assets/41fc00ae-d120-4370-ac26-79ccbb61d278) + +--- + +## 3. How to Compare Players +To compare players: +- Click the **Compare Players** button. +- You’ll be redirected to the **comparison page**, where Player 1 and Player 2 will be displayed side by side. +![Player comparion page](https://github.com/user-attachments/assets/f1816c4e-e18d-43f2-a5dc-d65d1447cc50) + + +On the comparison page: +- View the **career stat totals** for both players. +- For a visual comparison: + - Select a stat option from the dropdown menu to see a **graph comparison** of the players' performance. + ![Player comparison graph](https://github.com/user-attachments/assets/1d39628e-97da-41b5-ad4b-d75ff9c37ad1) + +--- + +Now you’re ready to explore ShotGeek and dive into basketball stats like never before! + + + + + + + +