Updated README.md

README.md

@@ -1,16 +1,54 @@
-# quickgui
+# Guickgui
 
-A new Flutter project.
+A new Flutter frontend for Quickget.
 
-## Getting Started
+## Build
 
-This project is a starting point for a Flutter application.
 
-A few resources to get you started if this is your first Flutter project:
+* [Set up Flutter](https://ubuntu.com/blog/getting-started-with-flutter-on-ubuntu)
+* Clone this repo,
+* Switch to the project's directory,
+* Build the project.
 
-- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
+```bash
+$ git clone https://github.com/ymauray/quickgui.git
+$ cd quickgui
+$ flutter build linux --release
+```
+
+## Run
+
+* From the project's folder, start the binary with : 
+```
+$ ./build/linux/x64/release/bundle/quickgui
+```
+
+Alternativelly, use `update-alternatives` to install `quickgui` system-wide :
+
+```bash
+sudo update-alternatives --install /usr/local/bin/quickgui quickgui /opt/flutter-projects/quickgui/build/linux/x64/release/bundle/quickgui 50
+```
+
+## Usage
+
+From the main screen, select the operating system you want to use :
+
+
+![Main screen](./assets/github/screenshot1.png)
+
+![List of supported operating systems](./assets/github/screenshot2.png)
+
+![The Ubuntu flavors](./assets/github/screenshot3.png)
+
+Then, select the version :
+
+![Main screen after selection of the operating system](./assets/github/screenshot4.png)
+
+![Versions of the selected operating system](./assets/github/screenshot5.png)
+
+Then click "Download". The ISO will be downloaded in the current working directory, in 99% of cases that will be the directory where `quickgui` was invoked from. The spinner will tell you where the file is being downloaded.
+
+![All set !](./assets/github/screenshot6.png)
+
+![Downloading](./assets/github/screenshot7.png)
 
-For help getting started with Flutter, view our
-[online documentation](https://flutter.dev/docs), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.