You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+20-13Lines changed: 20 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
A lightweight native macOS utility for running scripts and commands in the background - powered by Rust.
4
4
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.
6
6
7
7
If you’ve ever left a Terminal window open _“just to keep a command running”_, this app is for you.
8
8
@@ -12,7 +12,8 @@ If you’ve ever left a Terminal window open _“just to keep a command running
-`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`.
16
17
17
18
## Features
18
19
@@ -24,13 +25,12 @@ If you’ve ever left a Terminal window open _“just to keep a command running
24
25
25
26
## Installation
26
27
27
-
### Prerequisites
28
+
### macOS (native bundle)
28
29
30
+
Prereqs:
29
31
- Rust and Cargo (install via [rustup](https://rustup.rs/))
30
32
- 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`)
34
34
35
35
1. Clone the repository:
36
36
```bash
@@ -40,7 +40,15 @@ cd something_bg
40
40
41
41
2. Build and bundle the macOS application (run from repo root):
42
42
```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/
44
52
```
45
53
46
54
### Linux (tray shell)
@@ -71,18 +79,17 @@ The script builds an Ubuntu-based image with GTK/AppIndicator dev packages and r
71
79
72
80
Prereqs: Docker.
73
81
74
-
Cross-check with the bundled cargo-xwin image:
82
+
Cross-check/build with the bundled cargo-xwin image:
75
83
```bash
76
84
./scripts/windows-cargo-check.sh
77
85
```
78
86
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.
79
87
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
83
91
```
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`.
0 commit comments