From bfdd7b3411e21a6e4397ad19e32be2e6644e9d84 Mon Sep 17 00:00:00 2001 From: rambros Date: Tue, 24 Feb 2026 15:25:16 +0530 Subject: [PATCH] update readme --- README.md | 23 +++++--- build.bat | 53 ------------------ fluxer-reaper.jpg => images/fluxer-reaper.jpg | Bin 3 files changed, 16 insertions(+), 60 deletions(-) delete mode 100644 build.bat rename fluxer-reaper.jpg => images/fluxer-reaper.jpg (100%) diff --git a/README.md b/README.md index 3d83daa..fbed24e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Fluxer Reaper is a simple tool to help you move an entire Discord server over to a Fluxer community. It handles channels, roles, emojis, and even your message history. -![Fluxer Reaper](fluxer-reaper.jpg) +![Fluxer Reaper](images/fluxer-reaper.jpg) ## Features @@ -94,13 +94,22 @@ Finally open the **Install link** and add the bot to your Discord server ## Getting Started -### 1. Download -Download the latest executable from the [Releases](https://github.com/rambros3d/fluxer-reaper/releases) page & unzip it. +### Option 1: Using Pre-built Binaries (Easiest) +1. **Download**: Download the latest executable from the [Releases](https://github.com/rambros3d/fluxer-reaper/releases) page & unzip it. +2. **Run**: Simply run the downloaded file to start the tool. No Python installation is required. + - **Linux**: Run the **fluxer-reaper** file (or `./fluxer-reaper` in terminal). + - **Windows**: Run the **fluxer-reaper.exe** file. -### 2. Run -Simply run the downloaded file to start the tool. No Python installation is required. -- **linux**: run the **fluxer-reaper** file (bash **./fluxer-reaper** if terminal doesnt open automatically) -- **windows**: run the **fluxer-reaper.exe** file +### Option 2: Running from Source +1. **Clone**: Clone the repository to your local machine: + ```bash + git clone https://github.com/rambros3d/fluxer-reaper.git + cd fluxer-reaper + ``` +2. **Launch**: Run the appropriate launcher script for your OS. It will automatically create a virtual environment and install dependencies: + - **Linux**: `./launch-reaper-LINUX.sh` + - **MacOS**: `./launch-reaper-MAC.sh` + - **Windows**: Double-click `launch-reaper-WIN.bat` ### Documentation diff --git a/build.bat b/build.bat deleted file mode 100644 index ca557f2..0000000 --- a/build.bat +++ /dev/null @@ -1,53 +0,0 @@ -@echo off -setlocal enabledelayedexpansion - -echo --- Fluxer Reaper Windows Build Script --- - -:: Check for venv -if not exist "venv" ( - echo Creating virtual environment... - python -m venv venv - if errorlevel 1 ( - echo Error: Failed to create venv. Make sure Python is installed. - exit /b 1 - ) -) - -echo Activating virtual environment... -call venv\Scripts\activate - -echo Ensuring build dependencies are up to date... -python -m pip install --upgrade pip --quiet -pip install pyinstaller --quiet -pip install -r requirements.txt --quiet - -echo Cleaning previous build artifacts... -if exist "build" rd /s /q build -if exist "dist" rd /s /q dist - -echo Starting PyInstaller build... -pyinstaller --clean fluxer-reaper.spec - -echo Generating Launch-Reaper.bat launcher... -( -echo @echo off -echo cd /d "%%~dp0" -echo if exist "fluxer-reaper.exe" ^( -echo fluxer-reaper.exe -echo ^) else ^( -echo echo Error: fluxer-reaper.exe not found! -echo pause -echo ^) -) > dist\Launch-Reaper.bat - -echo Packaging release: fluxer-reaper-windows.zip... -copy config.example.yaml dist\ -powershell -Command "Compress-Archive -Path 'dist\fluxer-reaper.exe', 'dist\Launch-Reaper.bat', 'dist\config.example.yaml' -DestinationPath 'dist\fluxer-reaper-windows.zip' -Force" - -echo ----------------------------------- -echo Build complete! -echo Standalone executable: dist\fluxer-reaper.exe -echo Launcher script: dist\Launch-Reaper.bat -echo Release Package: dist\fluxer-reaper-windows.zip -echo --- -pause diff --git a/fluxer-reaper.jpg b/images/fluxer-reaper.jpg similarity index 100% rename from fluxer-reaper.jpg rename to images/fluxer-reaper.jpg