Add README and MIT license
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
aab55369f6
commit
b46d999405
5 files changed
+89
-1
No files matched your search
@@ -3,3 +3,4 @@
|
||||
/packaging/arch/src/
|
||||
/packaging/arch/pkg/
|
||||
/packaging/arch/*.pkg.tar*
|
||||
/packaging/arch/*.log
|
||||
@@ -2,6 +2,7 @@
|
||||
name = "ratbin"
|
||||
version = "0.1.0"
|
||||
edition = "2024"
|
||||
license = "MIT"
|
||||
|
||||
[dependencies]
|
||||
anyhow = "1.0.104"
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Marumarsudev
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,64 @@
|
||||
# ratbin
|
||||
|
||||
Integrate AppImages, standalone binaries and scripts into your desktop's application menu.
|
||||
|
||||
ratbin moves a file into an applications folder (`~/Applications` by default), makes it executable and writes a `.desktop` entry for it in `~/.local/share/applications`. For AppImages it pulls the embedded desktop entry and icon out of the image, so the menu entry looks the same as a packaged app.
|
||||
|
||||
## Features
|
||||
|
||||
- **Integrate** a single AppImage, ELF binary or script (`#!`).
|
||||
- **Bundle** a binary together with its companion files (libraries, data, configs) into its own folder. If the selection holds several executables, ratbin asks which one starts the app (zenity or kdialog), or you pass `--main`.
|
||||
- **Repair** entries after an AppImage updates or renames itself. ratbin remembers each file's identity (its AppImage update info, embedded desktop id, or a version-stripped name) and points the entry at the new file.
|
||||
- **Manage** entries in a terminal UI: edit name, comment, categories, icon, arguments and terminal flag; change the target file; remove an entry with or without its file.
|
||||
- **Thunar integration**: adds "Integrate into menu", "Integrate as bundle" and "Remove menu integration" to the right-click menu, with desktop notifications for the result.
|
||||
- **fastfetch**: prints fastfetch's package line with a `(ratbin)` count added, without counting AppImages twice.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
ratbin # open the interactive manager
|
||||
ratbin integrate <files>... # integrate each file on its own
|
||||
ratbin bundle [--main <file>] <files>...
|
||||
ratbin remove [--delete] <files>...
|
||||
ratbin relink <entry> <file> # point an entry at a different executable
|
||||
ratbin repair # fix entries whose file was renamed or updated
|
||||
ratbin list
|
||||
ratbin fastfetch
|
||||
ratbin thunar install|uninstall
|
||||
```
|
||||
|
||||
`integrate`, `bundle` and `remove` accept `--notify` to report the result as a desktop notification.
|
||||
|
||||
### TUI keys
|
||||
|
||||
| Key | Action |
|
||||
| --- | --- |
|
||||
| `↑`/`↓`, `j`/`k` | select |
|
||||
| `enter`, `e` | edit entry |
|
||||
| `f` | change the entry's file |
|
||||
| `d` | remove (then `e` entry only, `d` entry + file) |
|
||||
| `r` | repair and reload |
|
||||
| `q` | quit |
|
||||
|
||||
## Configuration
|
||||
|
||||
`~/.config/ratbin/config.toml` is created on first run:
|
||||
|
||||
```toml
|
||||
apps_dir = "~/Applications"
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
```fish
|
||||
cargo install --path .
|
||||
ratbin thunar install # optional: add the Thunar actions, then run `thunar -q`
|
||||
```
|
||||
|
||||
An Arch Linux `PKGBUILD` lives in `packaging/arch`. It also installs a `Ratbin` menu entry that opens the manager in kitty.
|
||||
|
||||
Optional runtime tools: `thunar`, `libnotify` (notifications), `zenity` or `kdialog` (main-binary picker), `desktop-file-utils` (menu cache refresh), `kitty` (menu entry), `fastfetch`.
|
||||
|
||||
## License
|
||||
|
||||
MIT, see [LICENSE](LICENSE).
|
||||
@@ -3,7 +3,7 @@ pkgver=0.1.0
|
||||
pkgrel=1
|
||||
pkgdesc="Integrate AppImages, binaries and scripts into the application menu via the Thunar context menu"
|
||||
arch=('x86_64')
|
||||
license=('unknown')
|
||||
license=('MIT')
|
||||
depends=('gcc-libs' 'glibc')
|
||||
makedepends=('cargo')
|
||||
optdepends=(
|
||||
@@ -33,4 +33,5 @@ build() {
|
||||
package() {
|
||||
install -Dm755 "$srcdir/target/release/ratbin" "$pkgdir/usr/bin/ratbin"
|
||||
install -Dm644 "$_root/assets/ratbin.desktop" "$pkgdir/usr/share/applications/ratbin.desktop"
|
||||
install -Dm644 "$_root/LICENSE" "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
|
||||
}
|
||||
Reference in new issue
Block a user