Huge readme update

README.md

@@ -1,5 +1,5 @@
 # Pulsely
-## Frequency response measurement software
+## Audio Quality Measurement Software
 
 <div style="width:100%;text-align:center;">
     <p align="center">
@@ -20,12 +20,15 @@
 
 ### Description
 
-Pulsely is a free program that allows you to very accurately and professionally measure the frequency response of audio systems, compare them and export
+**Pulsely** is a free program that allows you to accurately and professionally measure the frequency response, 
+harmonic distortion of audio systems. Also, it can do reference measurements and calculate approximate quality score
 
 Currently, there are 2 types of frequency response measurements:
 - Using frequency sweep (maximum accuracy, but annoying sound)
 - Using white noise (does not provide high accuracy, but allows you to quickly measure the frequency response without annoying sounds)
 
+In sweep mode **Pulsely** also measures THD (total harmonic distortions) with IEEE in dB
+
 *App and logo created by Fern Lane (aka. F3RNI)*
 
 ----------
@@ -40,3 +43,66 @@ Currently, there are 2 types of frequency response measurements:
 6. Select calibration profile (if available) in the **Reference** section
 7. Start measurement and wait
 8. Done! You can save frequency response to CSV file or export as PNG image *(it is recommended to open the application in full screen for an image in a higher resolution)*
+
+----------
+
+### Understanding the Results
+
+If you used a sweep (recommended) then the result should be 2 charts:
+- frequency response (level in dBFS (decibels relative to full scale) *vs* frequency)
+- total harmonic distortion (ratio of harmonics to fundamental in dB *vs* frequency)
+
+Basically, you should set up your system so that the frequency response graph is as flat as possible 
+and the distortion graph as low as possible
+
+But there are nuances. For example, a frequency response graph might have a sharp rolloff at the very end. 
+This is due to the built-in filters in the ADC. Also, the distortion curve may have strange peaks at the beginning 
+(up to 200Hz, sometimes even higher). Often this is due to the fact that the resolution of the FFT 
+does not allow you to accurately determine the levels of all harmonics and the signal fluctuates.
+
+----------
+
+### Run/compile from source
+
+### Windows
+
+- Download and install Python and pip https://www.python.org/downloads/
+- Download and unpack source code from https://github.com/F33RNI/Pulsely
+- Open terminal in `Pulsely-master` folder and run `pip install -r requirements.txt`
+- To run Pulsely: `python Pulsely.py`
+
+
+- To build, firstly update/install pyinstaller to the **latest** version: `pip install pyinstaller --upgrade`
+  - you can check version by typing `pyinstaller --version`. It should be >= 5.7.0
+- Install msvc-runtime to fix matplotlib error: `pip install msvc-runtime`
+- Run build script: `python Builder.py`
+- Compiled program is located in folder `./dist/Pulsely-x.x.x-Windows_...`
+  - to run it, just double-click on `Pulsely.exe` file
+
+### Linux
+
+- Install Python and pip: `sudo apt update && sudo apt install python3.10`
+- Install portaudio: `sudo apt install portaudio19-dev python3-pyaudio`
+- Clone source code: `git clone https://github.com/F33RNI/Pulsely`
+- Install requirements: `pip install -r requirements.txt`
+- To run Pulsely: `python Pulsely.py`
+
+
+- To build, firstly update/install pyinstaller to the **latest** version: `sudo pip install pyinstaller --upgrade`
+  - you can check version by typing `pyinstaller --version`. It should be >= 5.7.0
+- Run build script: `python Builder.py`
+  - type `y` (yes) if it asks `WARNING: The output directory "./build/Pulsely" and ALL ITS CONTENTS will be REMOVED! Continue? (y/N)`
+- Compiled program is located in folder `./dist/Pulsely-x.x.x-Linux_...`
+  - to run it, just double-click on `Pulsely` file
+
+### MacOS
+
+- Download and install python3: https://www.python.org/downloads/macos/
+- Install Homebrew: https://brew.sh/
+- Install portaudio with brew: `brew install portaudio`
+- Clone source code: `git clone https://github.com/F33RNI/Pulsely`
+- Install requirements: `pip3 install -r requirements.txt`
+- To run Pulsely: `python3 Pulsely.py`
+
+
+- Building an app on a MacOS 💩 is probably impossible