docs(setup): add how to instructions

Author: shan-shaji

README.md

@@ -1,14 +1,34 @@
 # Setup Flutter
 
-Automated script to install and setup Flutter development environment with Homebrew and FVM. Compatible with macOS and Linux.
+This script automates the installation of all required tools to set up a new machine to start developing with Flutter.
 
-## Install
+## Prerequisites
 
-```sh
+* The machine should be running macOS or Linux (Ubuntu/Debian).
+* The machine should have an active internet connection.
+* curl should be installed.
+
+## Steps to Run the Script
+
+1. Open the terminal.
+2. Run the following command:
+ ```sh
 curl -fsSl https://raw.githubusercontent.com/shan-shaji/setup-flutter/main/setup-flutter | /bin/bash
 ```
 
-This script will perform the following steps:
+3. Wait for the script to complete. It may take some time depending on the speed of your internet connection.
+
+## Support
+
+If you encounter any issues while running the script, please create an issue on the [GitHub repository](https://github.com/shan-shaji/setup-flutter/issues).
+
+## Failure and Success Cases
+
+* If any of the prerequisites are not met, the script will exit with an appropriate error message.
+* If any of the installations fail, the script will exit with an appropriate error message.
+* If the script completes successfully, all required tools will be installed and the machine will be ready for Flutter development.
+
+**Note:** This script will perform the following steps:
 
 - Install Home Brew
 - Install Snap - Linux
@@ -18,7 +38,8 @@ This script will perform the following steps:
 - Install FVM
 - Install Flutter default version
 
-## Supports 
+**Note**: The script does not install Xcode, JDK, or any other Android-related tools. You must have Xcode and JDK installed on macOS, and you need to configure Android Studio manually on both macOS and Linux.
+
+**Note:** This script installs the stable version of Flutter. If you want to install a different version, you can do so using `fvm`. For more information on `fvm`, please refer to the [GitHub repository](https://github.com/leoafarias/fvm).
 
-- ✅ Mac OS
-- ✅ Ubuntu
+**Note:** This script sets up `fvm` and adds it to the PATH. You can use `fvm` to manage different versions of Flutter on the same machine.

setup-flutter

@@ -1,19 +1,31 @@
 #!/bin/bash
 
-# Install Homebrew if it's not already installed
-which brew || /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+# Check if Homebrew is installed, and install it if necessary
+if ! command -v brew &> /dev/null; then
+    echo "Installing Homebrew..."
+    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+fi
 
 # Add Homebrew to the PATH if it's not already there
 if [ "$(uname)" == "Darwin" ]; then
-    # macOS
+
     if [ ! -f ~/.zshrc ]; then
         touch ~/.zshrc
     fi
+
     if ! grep -q 'eval "$(/opt/homebrew/bin/brew shellenv)"' ~/.zshrc; then
         (echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> ~/.zshrc
         eval "$(/opt/homebrew/bin/brew shellenv)"
     fi
+
+    # Check if brew command is available
+    if ! command brew -v &> /dev/null; then
+        echo "Homebrew not found. Please check the Homebrew installation and PATH setup."
+        exit 1
+    fi
+
 elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
+
     # Add homebrew to path if it's not already added
     if ! grep -q 'export PATH="/home/linuxbrew/.linuxbrew/bin:$PATH"' ~/.bashrc && ! grep -q 'export PATH="/home/linuxbrew/.linuxbrew/bin:$PATH"' ~/.zshrc; then
         if [ -n "$ZSH_VERSION" ]; then
@@ -23,7 +35,10 @@ elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
         fi
     fi
 
-    # Install snap if not installed
+    # Since --cask option is not supported in linux  using snap
+    # to install applications.
+    #
+    # Install snap package.
     if ! command -v snap &> /dev/null; then
         sudo apt-get update
         sudo apt-get install -y snapd
@@ -37,16 +52,6 @@ elif [ -n "$BASH_VERSION" ]; then
     source ~/.bashrc
 fi
 
-# Check if brew command is available
-# &> /dev/null: This is a redirection that redirects both 
-# the standard output and standard error streams of the command to the null device, 4
-# discarding any output that the command may produce. 
-# This is done to make the command run silently, without producing any output on the screen.
-if ! command brew -v &> /dev/null; then
-    echo "Homebrew not found. Please check the Homebrew installation and PATH setup."
-    exit 1
-fi
-x
 
 if [ "$(uname)" == "Darwin" ]; then
     # Install Java if it's not already installed