From 19ff176f0ad516023aa665fd16aecf3635c0496f Mon Sep 17 00:00:00 2001
From: Baggi <39710037+0xbaggi@users.noreply.github.com>
Date: Tue, 13 Aug 2024 14:19:13 +0200
Subject: [PATCH] feat: add README

---
 README.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 74 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 9056973..b8d4d34 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,80 @@
-# lg_space_visualizations
+# 🚀 Space Visualizations for Liquid Galaxy
 
-This is an educational application dedicated to visualizing orbits and the Mars 2020 mission, utilizing the Liquid Galaxy platform, to provide immersive space exploration experiences.
+## 📄Table of Contents
+* [📚 About](#-about)
+* [📝 Requirements](#-requirements)
+* [👨‍💻 Building from source](#-building-from-source)
+* [🌐 Connecting to Liquid Galaxy](#-connecting-to-LG)
 
-## Getting Started
+<a name="-about"></a>
+## 📚 About
 
-This project is a starting point for a Flutter application.
+Space Visualizations for Liquid Galaxy is an application that showcases the [Mars 2020](https://science.nasa.gov/mission/mars-2020-perseverance/) NASA mission and some of the most famous Earth orbits. The application uses the [Liquid Galaxy](https://www.liquidgalaxy.eu) platform to provide immersive space exploration experiences. In the Mars mission section, users can interactively learn about the mission by visualizing 3D models, technical data, and the path of the Perseverance rover and Ingenuity drone. Users can see Mars from the perspective of the Perseverance rover with more than 220000 photos available. The photos can also be displayed on all Liquid Galaxy screens, providing a very immersive experience.
 
-A few resources to get you started if this is your first Flutter project:
+In the Earth orbit section, a list of orbits can be displayed in both the application and, with a realistic representation, on Liquid Galaxy Google Earth. Users can interact with these orbits and learn more about them.
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+This project has been started as a [Google Summer of Code](https://summerofcode.withgoogle.com/about) 2024 project with the Liquid Galaxy Org.
+Developed by Mattia Baggini
+Mentor: Victor Sanchez
+Liquid Galaxy Org Director: Andreu Ibañez
+
+<a name="-requirements"></a>
+## 📝 Requirements
+
+1. **Device Compatibility:**
+   - The application requires an Android tablet running **Android 13 (API level 33)** or higher.
+
+2. **Liquid Galaxy Integration (Optional):**
+   - To fully utilize the Liquid Galaxy features, ensure that the **Liquid Galaxy core** is installed. For detailed installation instructions, please refer to the [Liquid Galaxy repository](https://github.com/LiquidGalaxyLAB/liquid-galaxy).
+
+3. **Displaying Rover Photos on Liquid Galaxy (Optional):**
+   - To enable the display of rover photos on the Liquid Galaxy screens, install the **display_images_service**. For more information and installation guidelines, visit the [display_images_service repository](https://github.com/0xbaggi/display_images_service).
+
+
+<a name="-building-from-source"></a>
+## 👨‍💻 Building from source
+
+First, open a new terminal and clone the repository with the command:
+
+```bash
+git clone https://github.com/LiquidGalaxyLAB/LG-Space-Visualizations.git
+```
+
+To use the Google Maps widget, you'll need to set up an API key for the [Google Maps SDK](https://developers.google.com/maps/documentation/android-sdk/overview). Follow these steps:
+
+1. Obtain a Google Maps API Key by following the instructions [here](https://developers.google.com/maps/documentation/android-sdk/get-api-key).
+2. Once you have the API key, navigate to the `android/app/main` directory within the cloned repository.
+3. Open the **AndroidManifest.xml** file in a text editor.
+4. Locate the following section in the **AndroidManifest.xml** file:
+
+```XML
+   <meta-data
+       android:name="com.google.android.geo.API_KEY"
+       android:value="YOUR_API_KEY" />
+```
+
+Now we can run the application, follow these steps:
+
+1. Navigate to the project directory:
+   ```bash
+   cd LG-Space-Visualizations
+   ```
+2. Install the necessary dependencies:
+   ```bash
+   flutter pub get
+   ```
+3. Launch the app:
+   ```bash
+   flutter run
+   ```
+> ❗ **Important:** Ensure you have a tablet device connected or an Android tablet emulator running before executing the `flutter run` command.
+
+<a name="-connecting-to-LG"></a>
+## 🌐 Connecting to Liquid Galaxy
+
+1. **Open the Application**: Launch the application on your device and go to the settings page.
+
+2. **Enter Liquid Galaxy Details**: Insert your Liquid Galaxy information into the form and click "Connect"
+
+3. **Confirmation**: If a confirmation message appears, your application is successfully connected!
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.