Skip to content

Commit 82d01fb

Browse files
committed
docs: add macOS support section to README
1 parent a1156f6 commit 82d01fb

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,25 @@ title = "Network Connections"
104104
cmd = ["ss", "-tulpn"]
105105
```
106106

107+
### 🍎 macOS Support
108+
109+
Perfdeck works great on macOS! While many Linux-native tools (like `mpstat` or `free`) are not available by default, you can easily add macOS-equivalent commands to your `perfdeck.toml`.
110+
111+
**Example macOS-friendly tabs:**
112+
```toml
113+
[[tab]]
114+
title = "Memory (vm_stat)"
115+
cmd = ["vm_stat"]
116+
117+
[[tab]]
118+
title = "Disk I/O (iostat)"
119+
cmd = ["iostat", "-w", "1", "-c", "2"]
120+
121+
[[tab]]
122+
title = "Battery Status"
123+
cmd = ["pmset", "-g", "batt"]
124+
```
125+
107126
## 🛠 Development
108127

109128
We utilize a simple `Makefile` for a streamlined development experience:

0 commit comments

Comments
 (0)