Merge pull request #30 from Manamama-Gemini-Cloud-AI-01/docs/improve-readme

docs: Improve README for new users

Author: bl-ue

README.md

@@ -1,107 +1,155 @@
-# Gemini Desktop
+# Your Gemini, Reimagined.
 
-A powerful, modern desktop and web UI for **Gemini CLI** and **Qwen Code**.  Built with Tauri and web technologies.  Cross-platform, open-source on [GitHub.](https://github.com/Piebald-AI/gemini-desktop)
+Ever felt that the command line, while powerful, can be a bit... impersonal? Gemini Desktop is a beautiful and intuitive graphical interface for Google's Gemini CLI and Qwen Code, designed to make your interactions with AI more natural and productive.
 
-> [!note]
-> :star2: **Star the repository** to stay up to date with notifications of [new releases](https://github.com/Piebald-AI/gemini-desktop/releases) and [announcements](https://github.com/Piebald-AI/gemini-desktop/discussions/categories/announcements).
+**So, why use a graphical interface instead of the command line?**
 
-**Using [Gemini CLI](https://github.com/google-gemini/gemini-cli):**
+*   **It's easier.** No need to memorize commands or flags. Everything is a click away.
+*   **It's visual.** See your conversations, code changes, and the AI's thought process laid out clearly.
+*   **It's more powerful for complex tasks.** Juggling multiple conversations, reviewing large code changes, and managing files is a breeze.
+*   **Access from anywhere.** With the web version, you can use your Gemini CLI running on one machine from any other device with a web browser.
 
 <img alt="Screenshot of Gemini Desktop" src="./assets/screenshot.png" width="600">
 
-**Using [Qwen Code](https://github.com/QwenLM/qwen-code):**
-
 <img alt="Screenshot of Gemini Desktop for Qwen Code" src="./assets/qwen-desktop.png" width="600">
 
-## Features
+## What you can do with Gemini Desktop
 
-- Choose between Gemini models (Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.5 Flash-Lite)
-- Use **Qwen.ai OAuth/custom OpenAI-compatible providers** and models with Qwen Code
-- Send messages to/from AI and receive response; handle tool call requests; Markdown support
-- Observe Gemini's **thought process**
-- View and handle edit requests with clear file diffs
-- Automatic light/dark mode switching
-- **Automatic chat history saving** (Note: See related PRs [#4401](https://github.com/google-gemini/gemini-cli/pull/4401) and [#4609](https://github.com/google-gemini/gemini-cli/pull/4609) on the Gemini CLI repo.)
-- Fast **search** across all conversation contents
-- Access Gemini CLI/Qwen Code running on **remote machines** with the web UI
+*   **Chat with your AI, effortlessly.** Have natural, flowing conversations with your AI. All your chats are automatically saved for you to come back to at any time.
+*   **See the AI's thought process.** Understand how the AI is working behind the scenes by watching its thoughts unfold in real-time.
+*   **Review code changes with confidence.** A clear, side-by-side view of proposed code changes makes it easy to see what's new and decide whether to accept it.
+*   **Work with different AI models.** Easily switch between different Gemini and Qwen models to find the best one for your needs.
+*   **Search your entire chat history.** Instantly find any message or piece of code from your past conversations.
 
-### Planned/in progress
+## Getting Started
 
-- MCP server management and integration
-- Git repository viewing
-- Dangerous `--yolo` mode support
-- Resuming saved conversations
-- Token/cost information
-- `@`-mentioning files
-- LLxprt integration ([#24](https://github.com/Piebald-AI/gemini-desktop/issues/24))
-- Multi-modal support
-- Extension support
+To get started, you'll need to build Gemini Desktop from the source code. Here's how:
+
+### 1. Install the Prerequisites
 
-## How it works
+Gemini Desktop is built with Rust and web technologies. You'll need to install the following tools first.
 
-Gemini CLI/Qwen Code can function as an ACP (Agent Communication Protocol) server, which enables real-time communication via JSON-RPC 2.0 between the client, Gemini Desktop, and the server, Gemini CLI.
+*   [Rust](https://rust-lang.org)
+*   [Node.js](https://nodejs.org)
+*   [pnpm](https://pnpm.io)
+*   [just](https://just.systems)
 
-## Building from source
+#### Installing `just`
 
-### Prerequisites
+`just` is a handy command runner we use to simplify the build process.
 
-Gemini Desktop is written using Rust and Tauri for the backend and web technologies for the frontend.  When building it from source or running it in development you'll need to install the following tools:
+*   **On macOS/Linux with `asdf`:**
 
-- [Rust](https://rust-lang.org)
-- [Node.js](https://nodejs.org)
-- [pnpm](https://pnpm.io)
-- [just](https://just.systems)
+    ```bash
+    asdf plugin add just
+    asdf install just latest
+    ```
 
-#### Installing Just
+*   **On Ubuntu:**
 
-If you're on macOS/Linux and you use [asdf](https://asdf-vm.com), you can install `just` with the following commands:
+    You can also install `just` using snap:
+
+    ```bash
+    snap install --edge --classic just
+    ```
+
+*   **On Windows:**
+
+    ```powershell
+    winget install --id Casey.Just
+    ```
+
+#### Linux Dependencies
+
+On Linux, you'll need a few extra packages for the desktop app to build correctly.
+
+*   **On Ubuntu:**
+
+    ```bash
+    sudo apt install libgdk-pixbuf-2.0-dev \
+       libpango1.0-dev \
+       libjavascriptcoregtk-4.1-dev \
+       libatk1.0-dev \
+       libsoup-3.0-dev \
+       libwebkit2gtk-4.1-dev
+    ```
+
+### 2. Clone the Repository
 
 ```bash
-asdf plugin add just
-asdf install just latest
+git clone https://github.com/Piebald-AI/gemini-desktop
+cd gemini-desktop
 ```
 
-If you're on Windows, you can use Winget:
+### 3. Build the Application
+
+This command will download all the necessary dependencies and build both the desktop and web versions of the application.
 
-```powershell
-winget install --id Casey.Just
+```bash
+just deps build-all
 ```
 
-#### Linux Dependencies
+### 4. Run Your Build
+
+Here’s how to run the applications you’ve just built:
+
+**Desktop App**
+
+For the best experience, use the installer. It will set up the application on your system, just like any other app.
+
+```bash
+# Navigate to the bundle directory
+cd target/release/bundle/
+
+# Run the installer for your system (the file name will vary)
+# For example, on Linux it might be:
+./Gemini.Desktop_0.1.0_amd64.AppImage
+```
 
-On Linux building Tauri apps requires several dependencies.  If you're using Ubuntu, you can install them all using this command:
+If you prefer to run the application without installing, you can run the executable directly:
 
 ```bash
-sudo apt install libgdk-pixbuf-2.0-dev \
-   libpango1.0-dev \
-   libjavascriptcoregtk-4.1-dev \
-   libatk1.0-dev \
-   libsoup-3.0-dev \
-   libwebkit2gtk-4.1-dev
+./target/release/gemini-desktop
 ```
 
-### Build
+**Web App (Web Server)**
 
-Then clone the repository:
+This will start a web server on your machine. You can then access Gemini Desktop from your browser.
 
 ```bash
-git clone https://github.com/Piebald-AI/gemini-desktop
-cd gemini-desktop
+# Run the web server executable
+./target/release/gemini-desktop-web
 ```
 
-You can run the app in development mode, or build it for production.  The desktop, being a Tauri app, follows the standard setup for development and production.  For the webapp, there are two servers that run in development mode: a Rust/Rocket backend API server on port 1858, and a Vite frontend webserver with hot reloading on port 1420.  In production a single executable hosts the backend API and the frontend, both on port 1858.
+Once the server is running, open your web browser and go to `http://localhost:1858`.
+
+## Features
+
+- Choose between Gemini models (Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.5 Flash-Lite)
+- Use **Qwen.ai OAuth/custom OpenAI-compatible providers** and models with Qwen Code
+- Send messages to/from AI and receive response; handle tool call requests; Markdown support
+- Observe Gemini's **thought process**
+- View and handle edit requests with clear file diffs
+- Automatic light/dark mode switching
+- **Automatic chat history saving** (Note: See related PRs [#4401](https://github.com/google-gemini/gemini-cli/pull/4401) and [#4609](https://github.com/google-gemini/gemini-cli/pull/4609) on the Gemini CLI repo.)
+- Fast **search** across all conversation contents
+- Access Gemini CLI/Qwen Code running on **remote machines** with the web UI
+
+### Planned/in progress
 
-**Development:** Run `just deps dev` to start the desktop app in development.  Alternatively, run `just deps dev-web` to start the webapp version in development and go to http://localhost:1420 in your browser.
+- MCP server management and integration
+- Git repository viewing
+- Dangerous `--yolo` mode support
+- Resuming saved conversations
+- Token/cost information
+- `@`-mentioning files
+- LLxprt integration ([#24](https://github.com/Piebald-AI/gemini-desktop/issues/24))
+- Multi-modal support
+- Extension support
 
-**Production:** Run `just deps build-all`.  Two binaries built in release mode will be produced in `target/release`: `gemini-desktop` (`gemini-desktop.exe`) for the desktop app, and `gemini-desktop-web` (`gemini-desktop-web.exe`) for the webapp version.
- 
 ## Contributing
 
-Contributions are welcome!
-1. Fork the repo.
-2. Clone it, optionally create a new branch, and then and make your changes.
-3. Add tests.
-4. Commit your changes and open a PR.
+Contributions are welcome! Please see the [contributing guide](CONTRIBUTING.md) for more details.
 
 ## License