From 429d1747c02c11b76891cc53e4e12fc7a78b57f7 Mon Sep 17 00:00:00 2001 From: Boris Pozdena Date: Sun, 27 Apr 2025 01:27:11 +0200 Subject: [PATCH] Updated readme --- README.md | 134 ++++++++++++++++++++++-------------------------------- 1 file changed, 54 insertions(+), 80 deletions(-) diff --git a/README.md b/README.md index fd25144..c91495b 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,87 @@ -> [!WARNING] -> OneDriveGUI v1.1.0 is only compatible with [OneDrive client v2.5.0](https://github.com/abraunegg/onedrive) . -> There is no backward compatibility with older OneDrive client versions. Please use [OneDriveGUI v1.0.3](https://github.com/bpozdena/OneDriveGUI/releases/tag/v1.0.3) for OneDrive client v2.4.x . - -> [!IMPORTANT] -> If you are using `sync_business_shared_folders` in of OneDrive v2.4.0, you will need to manually remove it from the config file. Check the [client documentation](https://github.com/abraunegg/onedrive/blob/onedrive-v2.5.0-release-candidate-1/docs/business-shared-items.md) for more details. - -> [!NOTE] -> If your OneDrive client v2.5 is not installed system wide, you can manually define the path to the OneDrive binary in the GUI settings. - -Example: - -![image](https://github.com/bpozdena/OneDriveGUI/assets/24818591/9595886f-850a-4f6a-a1b4-e0bd872eb5cc) - - - - - # OneDriveGUI ![GitHub all releases](https://img.shields.io/github/downloads/bpozdena/OneDriveGUI/total) ## About -A simple GUI for [Linux OneDrive Client](https://github.com/abraunegg/onedrive) with multi-account support. +A GUI for [Linux OneDrive Client](https://github.com/abraunegg/onedrive) with multi-account support. ![image](https://github.com/user-attachments/assets/00769399-1a65-4648-8705-7dee81ee4f52) - - - -## Feature highlights -- Management and configuration of multiple OneDrive accounts -- Asynchronous real-time monitoring of multiple OneDrive accounts -- Setup wizard for easy OneDrive profile creation and import -- Auto-sync on GUI startup -- Support for GUI based login process -- System tray (if supported by your desktop environment) -- Start minimized to tray/dock -- Input validation to prevent configuration of incompatible OneDrive client options -- Progress monitoring of multiple simultaneous file transfers. -- Import and management of SharePoint Shared Libraries -- Tooltips with brief explanation of various OneDrive Client configuration options. -- Prompt for re-sync authorization to prevent unexpected data loss. - +## Feature Highlights +- Management and configuration of multiple OneDrive accounts. +- Asynchronous real-time monitoring of multiple OneDrive accounts. +- Setup wizard for easy OneDrive profile creation and import. +- Auto-sync on GUI startup. +- Support for GUI-based login process. +- System tray (if supported by your desktop environment). +- Start minimized to tray/dock. +- Input validation to prevent configuration of incompatible OneDrive client options. +- Progress monitoring of multiple simultaneous file transfers. +- Import and management of SharePoint Shared Libraries. +- Tooltips with brief explanations of various OneDrive Client configuration options. +- Prompt for re-sync authorization to prevent unexpected data loss. ## Known Limitations -- No window shadows for Wayland sessions -- No window icon when using AppImage on Wayland session -- AppImage still requires the use of external browser for authentication +- No window shadows for Wayland sessions. +- No window icon when using AppImage on Wayland sessions. +- AppImage still requires the use of an external browser for authentication. - Check for other reported [issues/limitations](https://github.com/bpozdena/OneDriveGUI/issues). ## Compatibility -- Minimum supported OneDrive client v2.5.0 -- You will be shown warnings when your OneDrive Client is not up to date. +- Minimum supported OneDrive client version: v2.5.0. +- You will be shown warnings if your OneDrive Client is not up to date. - -## Other notes -- Questions, suggestions, contributions and bug reports are welcome. +## Other Notes +- Questions, suggestions, contributions, and bug reports are welcome. - Backup your OneDrive config files before importing them to the GUI. - Backup your data before use to prevent accidental file deletion due to OneDrive misconfiguration. -- No warranty. - +- No warranty. # Running and Installing OneDriveGUI -| :exclamation: |Ensure the latest version of [OneDrive for Linux](https://abraunegg.github.io/) is installed based on [instructions](https://github.com/abraunegg/onedrive/blob/master/docs/INSTALL.md) for your distro. | -|---------------|:--------------------------------------------------------------------------------------------| +| :exclamation: | Ensure the latest version of [OneDrive for Linux](https://abraunegg.github.io/) is installed based on [instructions](https://github.com/abraunegg/onedrive/blob/master/docs/INSTALL.md) for your distro. | +|-----------------------|:----------------------------------------------------------------------------------------------------------------| ## AppImage -1) Download the latest `OneDriveGUI-*-x86_64.AppImage` from the [release assets](https://github.com/bpozdena/OneDriveGUI/releases) -1) Make the .AppImage file executable with `chmod +x ./OneDriveGUI-<**version**>-x86_64.AppImage` and run it. +1) Download the latest `OneDriveGUI-*-x86_64.AppImage` from the [release assets](https://github.com/bpozdena/OneDriveGUI/releases). +1) Make the `.AppImage` file executable with `chmod +x ./OneDriveGUI-<**version**>-x86_64.AppImage` and run it. -| :memo: | Users of Ubuntu 22.04+ may also need to install FUSE2 with `sudo apt install libfuse2` | +| :memo: | Users of Ubuntu 22.04+ may also need to install FUSE2 with `sudo apt install libfuse2`. | |---------------|:--------------------------------------------------------------------------------------------| ## AUR -- An AUR package [onedrivegui-git](https://aur.archlinux.org/packages/onedrivegui-git) is available. (maintainer: ZhangHua) +- An AUR package [onedrivegui-git](https://aur.archlinux.org/packages/onedrivegui-git) is available (maintainer: ZhangHua). -## Running from source +## Running from Source 1) Ensure Python3 and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your system. -1) Clone or download content of this repository and cd into the resultant folder. - ``` - git clone https://github.com/bpozdena/OneDriveGUI.git - cd OneDriveGUI - ``` -1) Install dependencies: - ```sh - python3 -m pip install -r requirements.txt - ``` - -1) Start OneDrive GUI: - ```sh - cd src/ - python3 OneDriveGUI.py - ``` - - Optionally, you can detach the GUI from terminal by using the bellow command: +1) Clone or download the content of this repository and `cd` into the resultant folder: ```sh - cd src/ - nohup python3 OneDriveGUI.py > /dev/null 2>&1& + git clone https://github.com/bpozdena/OneDriveGUI.git + cd OneDriveGUI + ``` +1) Install dependencies: + ```sh + python3 -m pip install -r requirements.txt ``` -# Use +1) Start OneDrive GUI: + ```sh + cd src/ + python3 OneDriveGUI.py + ``` + + Optionally, you can detach the GUI from the terminal by using the command below: + ```sh + cd src/ + nohup python3 OneDriveGUI.py > /dev/null 2>&1 & + ``` + +# Usage - Once the GUI starts, you will be able to create a new OneDrive profile or import your pre-existing one. Just follow the wizard steps. - You can adjust your OneDrive profile options as needed. - Start OneDrive sync in monitor mode via the GUI by pressing the `Play` button. - - # Additional Notes -- When importing OneDrive config file, all comments will be removed. -- If multi-line options 'skip_file' and 'skip_dir' are used, they will be consolidated into a single line. -- List of managed OneDrive profiles is stored in `~/.config/onedrive-gui/profiles`. You can manually rename your profile or path to config file there. -- Newly created OneDrive config files are stored in `~/.config/onedrive/accounts/` -- Debug logs are saved in `/tmp/onedrive-gui/onedrive-gui.log`. Logging can be changed in the GUI settings. +- When importing a OneDrive config file, all comments will be removed. +- If multi-line options `skip_file` and `skip_dir` are used, they will be consolidated into a single line. +- The list of managed OneDrive profiles is stored in `~/.config/onedrive-gui/profiles`. You can manually rename your profile or path to the config file there. +- Newly created OneDrive config files are stored in `~/.config/onedrive/accounts/`. +- Debug logs are saved in ``. Logging can be changed in the GUI settings.