From 9f19f0ffe5b2f7e5df64fccd769fcde8bfcdf4c8 Mon Sep 17 00:00:00 2001 From: maxluli Date: Tue, 30 May 2023 10:47:34 +0200 Subject: [PATCH] Updated installation ReadMe --- README.md | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4c470d4..f9b3b0c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ -# Work in progress +# Track Trends Alpha 1.0 -# How to run it on your machine +# Installation -you will need to take a couple of folders and files in the /bin/debug or /bin/release folder +As this project is a little finnicky, installing it and making it run is quite a job. Grab a coffe and lets begin. -You need to take the recoverCookiesCSV.py in ./Test_Merge and put it in the /bin/... folder -Same for the all geckodriver-v0.xx.x-win32 folder +## Before installation -You also have to change the TESS_DATA_FOLDER constant in the Windows.cs file. A small one is included in the project files +- Make sure you have a recent version of python installed (tested with 3.9) +- Make sure you have chrome installed on your pc and that its installed in the default location +- Connect to the F1TV with your credentials (can be done after installation but sometimes it takes some time to get register into the cookies db so I would advise you to do it now to be sure you can use the app directly after installation) -Add those two environnement variables : - -1. MOZ_HEADLESS_WIDTH => 3840 -2. MOZ_HEADLESS_HEIGHT => 2160 - -I also added the "Clean_4K_2023.json" file. I would advise to put it in the bin/debug folder into a folder called "preset" that you will need to create if it does not exist. It is a pretty clean config file. \ No newline at end of file +## Installation process +1. First you will need to download the files from the project. +3. Before unzipping Ill advise checking if the folder is locked or not (to check you right click on the folder and all the way at the end of the context menu if there is a checkbox to unlock you need to check it). +4. You need to unzip the project. +5. Locate the .SLN file that represents the project. (Should be named either TrackTrends or Test_Merge) and open it in Visual Studio (Tested with 2022 community edition). +6. Before running it you need to go back to the file explorer and click on either the "TrackTrends" or "Test_Merge" folder and locate three very important files/folders (geckodriver-v0.xx.x-win32 folder,recoverCookiesCSV.py file,TessData folder) and put them into the ./bin/debug or ./bin/release folder. +7. If you want to store the TessData folder or if you already have it somewehere else on your machine (that can happen as thoses kind of files can be quite heavy) its possible, follow step 8. +8. Even if you have put the TessData folder in ./debug you will need to change in the file `Window.cs` file at line 39 the TESS_DATA_FOLDER constant to match your scenario. +9. Add those two Environnement variables as followed +- MOZ_HEADLESS_WIDTH => 3840 +- MOZ_HEADLESS_HEIGHT => 2160 +10. If you dont want to create your own config file at your first application start. I added for you a config file made for 2023 named `Clean_4K_2023.json` in the same folder as the python file. You will need to add it into a folder named `Presets` that you will have to create if it does not already exists +11. Have fun ! \ No newline at end of file