Skip to content

Commit 37ee523

Browse files
committed
Remove PROJECT.md and update docs for multi-platform support
The project plan file is now outdated. Update README with current workspace structure, platform support status, and build instructions for macOS, Linux, and Windows. Add bundle metadata override in app-macos to ensure correct .app naming.
1 parent e51b0bd commit 37ee523

3 files changed

Lines changed: 24 additions & 37 deletions

File tree

PROJECT.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A lightweight native macOS utility for running scripts and commands in the background - powered by Rust.
44

5-
`something_bg` is a tiny macOS status-bar app designed to take any script or command you already use and run it quietly in the background. No terminals to keep open, no remembering where scripts live, no complicated setup.
5+
`something_bg` is a tiny menu/tray app (macOS, Linux, Windows) designed to take any script or command you already use and run it quietly in the background. No terminals to keep open, no remembering where scripts live, no complicated setup.
66

77
If you’ve ever left a Terminal window open _“just to keep a command running”_, this app is for you.
88

@@ -12,7 +12,8 @@ If you’ve ever left a Terminal window open _“just to keep a command running
1212

1313
- `core/` — platform-agnostic logic (config, scheduler, tunnel management).
1414
- `app-macos/` — macOS shell (tray UI, oslog, wake detection) that links to `core`.
15-
- `app-linux/` — Linux shell (currently a CLI loop) that links to `core`.
15+
- `app-linux/` — Linux tray shell that links to `core`.
16+
- `app-windows/` — Windows tray shell that links to `core`.
1617

1718
## Features
1819

@@ -24,13 +25,12 @@ If you’ve ever left a Terminal window open _“just to keep a command running
2425

2526
## Installation
2627

27-
### Prerequisites
28+
### macOS (native bundle)
2829

30+
Prereqs:
2931
- Rust and Cargo (install via [rustup](https://rustup.rs/))
3032
- Xcode Command Line Tools
31-
- cargo-bundle (install with `cargo install cargo-bundle`)
32-
33-
### Building from Source
33+
- cargo-bundle (`cargo install cargo-bundle`)
3434

3535
1. Clone the repository:
3636
```bash
@@ -40,7 +40,15 @@ cd something_bg
4040

4141
2. Build and bundle the macOS application (run from repo root):
4242
```bash
43-
cargo bundle --release -p something_bg
43+
cargo bundle --release --bin something_bg
44+
```
45+
46+
3. Install or run
47+
```bash
48+
# run from build location
49+
open "target/release/bundle/osx/Something in the Background.app"
50+
# or install
51+
cp -r "target/release/bundle/osx/Something in the Background.app" /Applications/
4452
```
4553

4654
### Linux (tray shell)
@@ -71,18 +79,17 @@ The script builds an Ubuntu-based image with GTK/AppIndicator dev packages and r
7179

7280
Prereqs: Docker.
7381

74-
Cross-check with the bundled cargo-xwin image:
82+
Cross-check/build with the bundled cargo-xwin image:
7583
```bash
7684
./scripts/windows-cargo-check.sh
7785
```
7886
This builds `something_bg_windows` for `x86_64-pc-windows-msvc` using the Windows SDK bundled in the Docker image. Pass extra cargo args after the script if needed.
7987

80-
3. Move the app to your Applications folder:
81-
```bash
82-
cp -r "target/release/bundle/osx/Something in the Background.app" /Applications/
88+
To run on Windows natively, build on Windows with a Rust toolchain and the `tray-icon` deps:
89+
```powershell
90+
cargo build -p something_bg_windows --release
8391
```
84-
85-
Launch the app from your Applications folder. It will appear as a menu bar item.
92+
Then launch the produced `target\release\something_bg_windows.exe`.
8693

8794
## Configuration
8895

app-macos/Cargo.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ identifier = "com.vim-zz.something-bg"
1111
name = "Something in the Background"
1212
resources = ["../resources/*.png", "../resources/images/*.png"]
1313

14+
# Explicit bin-specific override so cargo-bundle names the .app correctly.
15+
[package.metadata.bundle.bin.something_bg]
16+
name = "Something in the Background"
17+
1418
[dependencies]
1519
something_bg_core = { path = "../core" }
1620
objc2 = "0.6"

0 commit comments

Comments
 (0)