Merge branch 'main' into feature/fasterCarsFromBehind

Author: DerMega

README.md

@@ -8,19 +8,42 @@ This is built with the intention of being easily approachable by developers who
 
 This project is still in the early stages of development, so there may be bugs and many missing features. If you are interested in contributing please reach out and we can discuss how we can collaborate.
 
+## Try it out
+
+You can try it out by downloading the latest release from the [releases page](https://github.com/tariknz/irdashies/releases).
+
+Install the .exe and run it. The application will automatically update when a new version is available.
+
 ## Table of Contents
 
 - [Introduction](#introduction)
+- [Prerequisites](#prerequisites)
 - [Installation](#installation)
 - [Usage](#usage)
+- [Folder Structure](#folder-structure)
+- [Storybook](#storybook)
+- [Package (create .exe)](#package-create-exe)
+- [Testing](#testing)
+- [Linting](#linting)
 - [Contributing](#contributing)
 - [License](#license)
 
 ## Introduction
 
 This project is built with React and Electron and uses the iRacing SDK to retrieve data from the iRacing live telemetry memory-map.
 
-## Installation
+## Prerequisites
+
+- Node.js (v20 or higher)
+- npm (comes with Node.js)
+- Windows build tools if you are on Windows
+  - `npm install -g windows-build-tools` from an elevated PowerShell (run as Administrator). 
+  - See [this guide](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules) for more details and alternative methods.
+- iRacing installed on your machine (Windows only)
+
+> Note: Developing on MacOS is fully supported and does not require iRacing or any additional tools to be installed as it uses a mocked SDK.
+
+## Installation (for development)
 
 To install IRDashies, follow these steps:
 
@@ -34,35 +57,20 @@ To install IRDashies, follow these steps:
   ```bash
   npm start
   ```
+5. Optionally, you can run the storybook to view the components in isolation:
+  ```bash
+  npm run storybook
+  ```
 
-### Generating tracks.json
-
-Since the track map relies on some iRacing assets this should be generated by the user and not committed to the repository.
-
-To generate the `tracks.json` file used for the track map, create a .env file in the root of the project with the following content:
-
-```
-IRACING_USERNAME=your-iracing-username
-IRACING_PASSWORD=your-iracing-password
-```
-
-This account needs to have access to the data API (see the following for details on how to enable legacy authentication: https://support.iracing.com/support/solutions/articles/31000173894-enabling-or-disabling-legacy-read-only-authentication).
-
-Then run the following command:
-
-```bash
-npm run generate-assets
-```
-
-## Usage
+## Usage (for development)
 
 To start using IRDashies, run the following command:
 ```bash
 npm start
 ```
 This will start the application.
 
-Look for the application in your app tray. Right-click on the icon and Lock / Unlock to resize and move overlays around.
+Look for the application in your app tray.
 
 > You will need to have Node.js installed on your machine to run the application. You can download it from [here](https://nodejs.org/).
 
@@ -115,6 +123,22 @@ To create the .exe and the installer run the following:
 npm run make
 ```
 
+## Testing
+
+To run the tests, run the following command:
+```bash
+npm run test
+```
+
+## Linting
+
+To run the linting, run the following command:
+```bash
+npm run lint
+```
+
+> Ensure you have ESLint extension installed if using VS Code and have enabled "Use Flat Config" in your settings.
+
 ## Developing on Mac
 
 As you may know, the iRacing SDK is only available on Windows. To develop on Mac OS, there is a mock SDK that is loaded which generates some dummy data for you to work with. This is useful for developing the UI components and widgets.
@@ -149,6 +173,12 @@ Displays a track map with the current position of the cars on track and the trac
 
 ![Track Map](./docs/assets/trackmap.png)
 
+### Weather
+
+Displays the weather information for the current session.
+
+![Weather](./docs/assets/weather.png)
+
 ## Contributing
 
 We welcome contributions to the IRDashies project! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.