From 2ff12ea5de7f839cf26fa974008989b14dfd773a Mon Sep 17 00:00:00 2001
From: DJDoubleD <34967020+DJDoubleD@users.noreply.github.com>
Date: Tue, 29 Oct 2024 16:56:53 +0100
Subject: [PATCH] Update build instructons (resolves #37) - create own .env
 file - create own .jks keystore - create own key.properties file

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/README.md b/README.md
index b9843d2..e1a4c10 100644
--- a/README.md
+++ b/README.md
@@ -79,6 +79,18 @@ git submodule init
 git submodule update
 ```
 
+Create a `.env` file in the `lib` folder of the project and add the following content:
+
+```text
+# Deezer API credentials
+deezerClientId = '<Your_Deezer_Client_Id>';
+deezerClientSecret = '<Your_Deezer_Client_Secret>';
+
+# LastFM API credentials
+lastFmApiKey = '<Your_LastFM_API_Key>'
+lastFmApiSecret = 'Your_LastFM_API_Secret'
+```
+
 Build generated files:
 
 Use following script to (re)build generated classes in submodules and main project:
@@ -103,6 +115,29 @@ Compile:
 
 NOTE: You have to use own keys, or build debug using `flutter build apk --debug`
 
+### Generate your own keys
+
+#### Step 1: create a JKS file
+
+Make sure your Java JDK folder is in your PATH variable and execute the following command in the ./android folder of the project:
+
+```bash
+keytool -genkey -v -keystore ./keys.jks -keyalg RSA -keysize 2048 -validity 10000 -alias <YourKeyAlias>
+```
+
+Follow the instructions show in the commandline to fill out the desired fields of your keystore.
+
+#### Step 2: create a key.properties file
+
+Inside the ./android (next to the keys.jks file from step 1), create a file `key.properties` with the following contents:
+
+```text
+storePassword=<storePassword>
+keyPassword=<keyPassword>
+keyAlias=<YourKeyAlias>
+storeFile=../keys.jks
+```
+
 ## Disclaimer & Legal
 
 **ReFreezer** was not developed for piracy, but educational and private usage.