Add README, icon and uninstaller

2026-10-22 23:05:30 +00:00
parent def171a0d9
commit 399d2049ff
3 changed files with 55 additions and 0 deletions
@@ -0,0 +1,50 @@
+# Satsuma
+
+Right-click file converter for Windows. Select a file in File Explorer or on the desktop, choose **Convert to (Satsuma)**, and pick a format. No program opens, and the original file is never changed. The new file lands next to it.
+
+Download page: https://wirc.cloud/satsuma
+
+## What it converts
+
+- **Pictures:** HEIC, WebP, PNG, JPG, BMP, TIFF and GIF convert to JPG, PNG, WebP, BMP, TIFF or PDF. A GIF can also become an MP4.
+- **Video:** MP4, MKV, WebM, AVI, MOV, WMV, FLV and MPG convert to each other. Any video can be saved as an MP3.
+- **Audio:** MP3, WAV, FLAC, OGG, M4A and Opus convert to each other.
+- **Documents:** Word, Excel, PowerPoint, RTF, text and OpenDocument files convert to PDF using Microsoft Office or LibreOffice.
+
+## Install
+
+1. Download Satsuma.zip from the Releases page and extract it.
+2. Double-click Install.bat. Windows may warn about an unknown app. Choose More info, then Run anyway.
+3. Right-click a file and choose Convert to (Satsuma).
+
+Setup needs no administrator rights. It copies a few small scripts to `%LOCALAPPDATA%\Satsuma`, downloads ffmpeg and ImageMagick (about 130 MB, once) into that folder, and adds the menu entries for the current user.
+
+On Windows 11 the menu appears under Show more options. Setup offers to turn on the classic full right-click menu. Sign out and back in after you do.
+
+## Remove
+
+Run Uninstall.bat. It removes the menu entries and the downloaded converters.
+
+## How it works
+
+Each menu entry runs Run.vbs, which starts Convert.ps1 with no visible window. Convert.ps1 picks the right tool for the job:
+
+- ffmpeg for video and audio
+- ImageMagick for pictures, including HEIC
+- Microsoft Office (or LibreOffice) for documents to PDF
+
+Conversions run one at a time. A small tray pop-up shows when each one starts and finishes, and failures are written to `log.txt` in the Satsuma folder.
+
+## Files
+
+| File | What it does |
+| --- | --- |
+| Install.bat, Install.ps1 | Copies the scripts, downloads the tools, adds the right-click menu |
+| Uninstall.bat, Uninstall.ps1 | Removes the menu and the Satsuma folder |
+| Convert.ps1 | Does the conversion |
+| Run.vbs | Starts Convert.ps1 without a console window |
+| satsuma.ico | Menu icon |
+
+## Credits
+
+Satsuma uses [ffmpeg](https://ffmpeg.org/) and [ImageMagick](https://imagemagick.org/). It was inspired by the Mac app Tangerine and is not affiliated with it.
@@ -0,0 +1,5 @@
+@echo off
+title Satsuma removal
+powershell.exe -NoProfile -ExecutionPolicy Bypass -File "%~dp0Uninstall.ps1"
+echo.
+pause