From d453b63f21019c03f84f1016478e98f5e55d3a65 Mon Sep 17 00:00:00 2001
From: Bryce W <58643544+02bwilson@users.noreply.github.com>
Date: Sun, 16 Jul 2023 11:15:23 -0400
Subject: [PATCH] Create README.md
---
README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 44 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..24e9908
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+
Oscilloground
+
+[![Oscilloground](https://github.com/02bwilson/Oscilloground/actions/workflows/python-app.yml/badge.svg)](https://github.com/02bwilson/Oscilloground/actions/workflows/python-app.yml)
+
+ Oscilloground is a Python program that provides a user-friendly interface to combine different signals and visualize them in the time and frequency domains. It utilizes PyQt6 for the graphical user interface and SciPy for signals. With Oscilloground, you can add custom signals and use various operators to create complex signal combinations for analysis and visualization.
+
+# Features
+
+ Combine different signals using various operators.
+ Real-time visualization of signals in the time and frequency domain.
+ Easily adjust signal parameters and observe their effects.
+
+# Prerequisites
+
+Make sure you have the following software installed before running Oscilloground:
+
+ Python (version 3.6 or higher)
+ PyQt6
+ SciPy
+
+# Installation
+
+Clone this repository and install the required dependencies:
+
+```git clone https://github.com/yourusername/Oscilloground.git```
+
+```cd Oscilloground```
+
+```pip install -r requirements.txt```
+
+# Usage
+
+To launch Oscilloground, run the following command:
+
+```python oscilloground.py```
+
+# How to Use
+
+ Launch the Oscilloground application.
+ In the GUI, you'll see options to add various standard signals (e.g., sine, square, sawtooth).
+ Select the signals you want to combine and use operators like addition, multiplication, etc., to create your desired signal composition.
+ Observe the real-time visualization of the resulting signal in the time and frequency domains.
+ Adjust signal parameters to see how it affects the combined signal.
+