From a486518dbfb723476bf314eae79f55f7e84b9cfa Mon Sep 17 00:00:00 2001
From: a0kami <dev.aokami@netc.fr>
Date: Sun, 10 Aug 2025 03:52:46 +0200
Subject: [PATCH] added readme

---
 readme.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..0e72eb5
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,23 @@
+# Rumble Wrecker
+
+This is an attempt at making an audio signal monitoring iced app.
+Something a bit like python app Friture, but in rust, hopefully with less dependencies, and eventually less portability.
+
+It uses pipewire to create a stream and connect it to capture stereo audio from default device output device monitor, pipewire will also be used to select specific devices instead.
+
+## Planned Features
+
+- [X] Waveform
+- [ ] Metering
+  - [ ] Peak dBFS
+  - [ ] True Peak (dbTP)
+  - [ ] RMS dBFS
+  - [ ] LUFS
+- [ ] Spectrum
+- [ ] Spectrogram
+  - [ ] Linear
+  - [ ] Log
+  - [ ] Mel
+  - [ ] min*max (s/l window)
+  - [ ] Wavelet
+- [ ] Vectorscope