Skip to content

Commit f2c70cd

Browse files
authored
Update README.md
1 parent 2e5f703 commit f2c70cd

File tree

1 file changed

+32
-29
lines changed

1 file changed

+32
-29
lines changed

README.md

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,50 @@
1-
# Oscilloscope Project (Work in Progress)
1+
# Oscilloscope
22

3-
This repository contains the initial stages of our oscilloscope project, aimed at developing a highly optimized, high-detail oscilloscope for use in various other projects. \
4-
As this is a work in progress, many features are incomplete or under active development.
3+
> [!WARNING]
4+
> Dimethoxy Oscilloscope is currently a work in progress. While it's functional, some features are unfinished, and certain buttons or functionalities may not work as expected.
5+
> Expect updates and improvements as development continues!
56
6-
## Project Goals
7+
The Oscilloscope is a real-time audio visualization plugin designed to give you precise insight into your waveforms. Whether you're shaping kicks for Hardstyle, dialing in sound design, or just want a slick visual representation of your audio, this tool delivers crisp, responsive visuals with minimal CPU impact.
78

8-
The main objectives of this project include:
9-
- **High Optimization:** Ensuring the oscilloscope runs efficiently on minimal hardware.
10-
- **High Detail:** Capturing and displaying waveforms with high precision and clarity.
11-
- **Integration:** Seamlessly integrating the oscilloscope into other Dimethoxy projects for real-time signal analysis.
9+
## 🔥 Features
1210

13-
## Current Status
11+
- **Free & Open-Source** – No paywalls, no restrictions
12+
- **Real-Time Waveform Display** – See your audio as it happens
13+
- **Minimalist UI** – Clean, distraction-free vector interface
14+
- **Scalable UI** – Optimized for high-resolution screens
15+
- **Intuitive Controls** – Get the data you need without unnecessary complexity
16+
- **High Resolution** – Designed to be super high detail
17+
- **Cross-Platform** – Supports Windows, macOS, and Linux
18+
- **Multi-Format Support** – Works with VST3, CLAP, LV2, and AU formats
19+
- **Regular Updates** – Continuous improvements and new features
20+
- **Privacy First** – No tracking, no data collection
1421

15-
- Basic waveform capture implemented
16-
- Preliminary UI design in place
17-
- Initial testing phase started
22+
## 🚧 Work in Progress
1823

19-
## Planned Features
24+
The Oscilloscope is still in development, and we’re actively working on the following features before the first official release:
2025

21-
- Zoom in/out functionality for detailed waveform analysis
22-
- Beat sync to align with musical or rhythmic signals
26+
- **Customizable Display** – Adjust color schemes, grid overlays, and line thickness
27+
- **Trigger Modes** – Options for free-running, synced, or transient-based triggering
28+
- **Performance Optimizations** – Further refining efficiency for even lower CPU usage
29+
- **Update Notifications** – Non-intrusive alerts for new versions
30+
- **Code Signing for macOS** – Ensuring macOS users can install without security warnings
31+
- **Installer Wizards** – Simple installation processes for both macOS and Windows
32+
- **Package Manager Support** – Easy installation via Linux package managers like AUR
2333

24-
## Getting Started
34+
## 💖 Donations
2535

26-
While the project is still under construction, you can clone the repository and experiment with the current features. Contributions and feedback are welcome as we continue to build out this tool.
27-
28-
```bash
29-
git clone https://github.com/yourusername/oscilloscope.git
30-
```
31-
32-
## Donations
33-
34-
If you have enjoyed using our software, please consider donating.
36+
If you enjoy using our software, please consider donating.
3537
[Donate via PayPal](https://www.paypal.com/donate/?hosted_button_id=8SJXCUYV5ZHKG)
3638

37-
We are dedicated to providing high-quality audio tools to the community for free, and your support helps us to continue our work. Your donation will contribute to maintaining and improving our software, as well as supporting the development of new tools and features. We greatly appreciate your support and thank you for helping us to continue our work.
39+
We’re committed to providing high-quality audio tools to the community for free. Your support helps maintain and improve our software while enabling the development of new tools and features. Every contribution is greatly appreciated!
3840

39-
## License
41+
## 📜 License
4042

41-
The source code is licensed under the **GPLv3**. If you download the source or create builds, you must comply with that license. For more information, visit [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
43+
The source code is licensed under **GPLv3**. If you download the source or create builds, you must comply with this license. For more information, visit [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
4244

43-
## Warranty
45+
## ⚠️ Warranty
4446

4547
You and your end-users use the software at your own risk.
4648

4749
**THE SOFTWARE IS PROVIDED “AS IS,” WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.**
50+

0 commit comments

Comments
 (0)