Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ninjaeon authored Dec 8, 2024
1 parent 2e789d2 commit e629224
Showing 1 changed file with 59 additions and 16 deletions.
75 changes: 59 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,68 @@
# ⚠️ AI-Generated Fork Disclaimer
# Gemini Desktop (Unofficial Enhanced Fork)

**WARNING: This is an experimental fork of Gemini Desktop with AI-generated modifications that have not been manually reviewed. Use at your own risk.**
[![GitHub release (with filter)](https://img.shields.io/github/v/release/ninjaeon/gemini-desktop-fork?include_prereleases)](https://github.com/ninjaeon/gemini-desktop-fork/releases)

**⚠️ Mac and Linux Warning: Mac and Linux builds in this fork are completely untested. Windows is the only tested platform.**
This is an enhanced, unofficial desktop client for Google Gemini, built upon the original [Gemini Desktop](https://github.com/nekupaw/gemini-desktop) by [nekupaw](https://github.com/nekupaw). This fork leverages the Electron framework to provide a cross-platform experience and introduces several improvements and new features.

This fork includes:
- Updated Electron to version 33.3.0 based on Chromium 130.0.6723.152 (from Electron 32.1.2)
- Fixed links to open in default external browser
- Enabled Context Menu for copy/paste, Search with Google, copying links, etc.
- Added "Check for Updates" button with manually-triggered autoupdater
**⚠️ Important Notes & Warnings:**

**⚠️ Security Notice**: Due to the automated nature of the modifications and lack of manual code review, this fork may contain security vulnerabilities or bugs. It is not recommended for production use.
* **Experimental AI-Generated Code:** This fork includes experimental, AI-generated code modifications that are **not yet manually reviewed**. Exercise caution and use at your own risk.
* **Untested Platforms:** **Mac and Linux builds are currently untested.** Windows is the only verified working platform. Feedback and contributions for these platforms are highly encouraged!
* **Security Considerations:** The experimental nature and the absence of thorough code review might introduce security vulnerabilities or bugs. This version is **not recommended for production use** until further testing and validation.

Fork of the original Gemini Desktop Client by [nekupaw](https://github.com/nekupaw/gemini-desktop)
(below is copied from the original repository README)
## Key Features & Enhancements (Over Original)

# Google-Gemini Desktop Client (Electron)
I've developed a straightforward desktop client for Google Gemini (formerly Bard) using the Electron framework.
* **Updated Electron:** Upgraded to Electron v33.3.0 (Chromium 130.0.6723.152) for enhanced performance and security.
* **External Link Handling:** All links now open in your default external web browser, improving navigation and user experience.
* **Context Menu:** Enabled a right-click context menu for:
* Copy/Paste (text and images)
* Search with Google
* Copying links
* Select All
* **Manual Update Checker:** Added a "Check for Updates" button in the system tray to manually trigger update checks.
* **Global Shortcut:** Access Gemini from anywhere with the shortcut `Ctrl + G` (configurable).
* **Startup Option:** Use the installer and copy the shortcut from the desktop to your startup folder for automatic launch.

This client operates by utilizing a WebView container to access the Gemini website and implements various modifications for enhanced user experience.
With the shortcut Ctrl + G, Gemini can be opened from anywhere.
tip: use the installer and copy the shortcut from the desktop to the startup folder.
## Release Notes (Latest: v1.0.7-fork.3)

* **Keybinding Fix:** Resolved an issue where keybindings were not being set correctly. ([View changes on GitHub](https://github.com/ninjaeon/gemini-desktop-fork/compare/v1.0.7-fork.2...v1.0.7-fork.3))

**Previous Release Highlights:**

* **v1.0.7-fork.2:** Enhanced security by removing a web security attribute, added manual update checker.
* **v1.0.7-fork.1:** Electron upgrade, external link handling, context menu features.

## Installation

**Windows:**

1. Download `Gemini-Desktop-Setup-1.0.7-fork.3.exe` (installer) or `Gemini-Desktop-1.0.7-fork.3-win.zip` (portable).
2. Installer: Run the `.exe` file.
3. Portable: Unzip and run `Gemini-Desktop.exe`.

**macOS (Untested):**

1. Download `Gemini-Desktop-1.0.7-fork.3-arm64.dmg` or `Gemini-Desktop-1.0.7-fork.3-arm64-mac.zip`.
2. DMG: Open the `.dmg` and drag the app to your Applications folder.
3. ZIP: Unzip and drag the app to your Applications folder.

**Linux (Untested):**

1. Download the appropriate file:
* `Gemini-Desktop-1.0.7-fork.3.AppImage` (most distributions)
* `gemini-desktop-1.0.7-fork.3.x86_64.rpm` (RPM-based)
* `gemini-desktop_1.0.7-fork.3_amd64.deb` (Debian-based)
2. If needed, make the file executable (e.g., `chmod +x Gemini-Desktop-1.0.7-fork.3.AppImage`).
3. Run the file.

## Contributing

Contributions are welcome! If you encounter any issues, especially on macOS or Linux, please report them on the [Issues](https://github.com/ninjaeon/gemini-desktop-fork/issues) page. If you are interested in contributing code, please open a pull request.

## Disclaimer

This project is not affiliated with or endorsed by Google. It is an independent, community-driven effort to enhance the Gemini user experience.

## Credits

* Original Gemini Desktop Client: [nekupaw](https://github.com/nekupaw/gemini-desktop)

0 comments on commit e629224

Please sign in to comment.