Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
clement2026 authored Aug 5, 2024
1 parent dc7f0b9 commit 3df456c
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,32 @@
## approf
A native macOS app to view [pprof](https://github.com/google/pprof) profiles. Open captured pprof files directly in the app without using the terminal.
https://github.com/user-attachments/assets/d61cd45f-abd8-4fa1-9038-5f9968ce9c9c

## A native macOS app for [pprof](https://github.com/google/pprof)
Open pprof profiles without command-line hassle ✨.

## Install
Download the latest app from [release](https://github.com/moderato-app/approf/releases/latest).

## Requirements
* `Graphviz` installed
* macOS **Sonoma** or later on a **M-series chip**

https://github.com/user-attachments/assets/d61cd45f-abd8-4fa1-9038-5f9968ce9c9c

## Features
- [x] Drag and drop pprof files to open
- [x] Compare pprof profiles using the [`-diff_base`](https://github.com/google/pprof/blob/main/doc/README.md#comparing-profiles) option
- [x] Reorder / Add / Remove files in seconds
- [x] Dark / Light mode
- [x] Save sessions for later use

## Screenshots
<img width="100%" alt="Screenshot" src="https://github.com/user-attachments/assets/efff596b-302d-45c9-8795-1ff8633e7d0f">
<div align="center">Command line under the hood</div>
<br/>
<br/>
<img width="100%" alt="Screenshot" src="https://github.com/user-attachments/assets/d34f68fb-8aa6-46ad-9a34-7c97c1a3ae0b">
<div align="center">WEB page in dark mode </div>

## Implementation
* SwiftUI and AppKit as the UI framework.
* The Composable Architecture for state management.
* Running [pprof](https://github.com/golang/go/tree/master/src/cmd/pprof) binay in a process.

0 comments on commit 3df456c

Please sign in to comment.