Formatted Markdown files for consistent style and readability

Author: ilvoron

.prettierrc

@@ -0,0 +1,21 @@
+{
+  "proseWrap": "always",
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "singleQuote": false,
+  "trailingComma": "none",
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "parser": "markdown",
+        "printWidth": 80,
+        "tabWidth": 2,
+        "proseWrap": "always"
+      }
+    }
+  ]
+}

LICENSE.md

@@ -2,20 +2,19 @@ MIT License
 
 Copyright (c) 2024 Vorontsov Ilya Aleksandrovich (ilvoron)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 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.
+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.

README.md

@@ -1,32 +1,41 @@
 # Signal Processing Library (SignalProcesserCPP)
 
-This project provides a set of classes for signal generation, processing, file I/O, and visualization using GnuPlot. It is designed for handling basic signal processing tasks, managing signal parameters, and visualizing signals in a clear and flexible way.
+This project provides a set of classes for signal generation, processing, file
+I/O, and visualization using GnuPlot. It is designed for handling basic signal
+processing tasks, managing signal parameters, and visualizing signals in a clear
+and flexible way.
 
 ## Features
 
--   **Signal Generation**: Generate customizable signal lines with adjustable frequency, amplitude, phase, and more.
--   **Signal Line Manipulation**: Modify and retrieve individual points of the signal.
--   **File I/O**: Save generated signal lines to files and load them for further processing.
--   **GnuPlot Visualization** (must be pre-installed): Easily visualize signal data using GnuPlot with configurable axis and graph labels.
+- **Signal Generation**: Generate customizable signal lines with adjustable
+  frequency, amplitude, phase, and more.
+- **Signal Line Manipulation**: Modify and retrieve individual points of the
+  signal.
+- **File I/O**: Save generated signal lines to files and load them for further
+  processing.
+- **GnuPlot Visualization** (must be pre-installed): Easily visualize signal
+  data using GnuPlot with configurable axis and graph labels.
 
 ## Installation
 
 1. Clone the repository:
 
-    ```bash
-    git clone https://github.com/ilvoron/SignalProcesserCPP
-    cd SignalProcesserCPP
-    ```
+   ```bash
+   git clone https://github.com/ilvoron/SignalProcesserCPP
+   cd SignalProcesserCPP
+   ```
 
-2. Build the project (assuming a C++ compiler, `cmake` and `make` are installed):
+2. Build the project (assuming a C++ compiler, `cmake` and `make` are
+   installed):
 
-    ```bash
-    cd "_build_folder_"
-    cmake -G "_generator_name_" "_path_to_main_cmake_lists_file_"
-    make
-    ```
+   ```bash
+   cd "_build_folder_"
+   cmake -G "_generator_name_" "_path_to_main_cmake_lists_file_"
+   make
+   ```
 
-3. Ensure you have [GnuPlot](http://www.gnuplot.info/) installed on your system for visualization functionality.
+3. Ensure you have [GnuPlot](http://www.gnuplot.info/) installed on your system
+   for visualization functionality.
 
 ## Usage
 
@@ -71,25 +80,37 @@ int main() {
 
 ## Dependencies
 
--   **C++20** or higher
--   **GnuPlot**: Required for signal visualization
--   **CMake** & **Make**: For building the project
+- **C++20** or higher
+- **GnuPlot**: Required for signal visualization
+- **CMake** & **Make**: For building the project
 
 ## License
 
-This project is licensed under the MIT License. See the [LICENSE.md](./LICENSE.md) file for details.
+This project is licensed under the MIT License. See the
+[LICENSE.md](./LICENSE.md) file for details.
 
 ## Contributing
 
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
-Feel free to adjust this template to better reflect your project's structure and the specific functionality you offer.
+Pull requests are welcome. For major changes, please open an issue first to
+discuss what you would like to change. Feel free to adjust this template to
+better reflect your project's structure and the specific functionality you
+offer.
 
 ---
 
 ## Classes Overview
 
--   **SignalProcesserException** - Custom exception class for handling errors during signal processing. It includes additional details like the function name where the error occurred.
--   **TSignalLine** - Represents a signal line made up of multiple points. Parameters such as frequency, amplitude, and phase can be customized. You can set, retrieve, and manipulate individual points in the signal.
--   **TGenerator** - Generates a signal line based on given parameters. The class supports execution of the signal generation process and provides access to the generated signal line.
--   **TFileWriter** - Responsible for writing signal data to a file. Accepts a signal line and a file path and saves the signal data in a specified format.
--   **TGnuPlotViewer** - Visualizes the signal data using GnuPlot. You can configure the file path, axis labels, and graph labels, and execute GnuPlot to render the graph.
+- **SignalProcesserException** - Custom exception class for handling errors
+  during signal processing. It includes additional details like the function
+  name where the error occurred.
+- **TSignalLine** - Represents a signal line made up of multiple points.
+  Parameters such as frequency, amplitude, and phase can be customized. You can
+  set, retrieve, and manipulate individual points in the signal.
+- **TGenerator** - Generates a signal line based on given parameters. The class
+  supports execution of the signal generation process and provides access to the
+  generated signal line.
+- **TFileWriter** - Responsible for writing signal data to a file. Accepts a
+  signal line and a file path and saves the signal data in a specified format.
+- **TGnuPlotViewer** - Visualizes the signal data using GnuPlot. You can
+  configure the file path, axis labels, and graph labels, and execute GnuPlot to
+  render the graph.

SECURITY.md

@@ -2,7 +2,9 @@
 
 ## Supported Versions
 
-The table below outlines the versions of `SignalProcesserCPP` that currently receive security updates. Please ensure you are using a supported version to stay protected with the latest patches.
+The table below outlines the versions of `SignalProcesserCPP` that currently
+receive security updates. Please ensure you are using a supported version to
+stay protected with the latest patches.
 
 | Version | Supported          |
 | ------- | ------------------ |
@@ -11,16 +13,24 @@ The table below outlines the versions of `SignalProcesserCPP` that currently rec
 
 ## Reporting a Vulnerability
 
-If you discover a security vulnerability in `SignalProcesserCPP`, please follow the steps below:
+If you discover a security vulnerability in `SignalProcesserCPP`, please follow
+the steps below:
 
-1. **Where to report**: Please send all vulnerability reports directly to **[telegram](https://t.me/il_voron) (@il.voron)** or email (il.voron.work@gmail.com). Include detailed information, such as steps to reproduce the vulnerability, if applicable.
+1. **Where to report**: Please send all vulnerability reports directly to
+   **[telegram](https://t.me/il_voron) (@il.voron)** or email
+   (il.voron.work@gmail.com). Include detailed information, such as steps to
+   reproduce the vulnerability, if applicable.
 
 2. **What to expect**:
+
    - I will acknowledge receipt of your report as soos as I can.
    - You will receive updates as I investigate and address the issue.
 
 3. **Response and Resolution**:
-   - If the vulnerability is confirmed, I will prioritize creating a security patch and release it as soon as possible.
-   - If the issue is not accepted or determined to be non-critical, I will provide an explanation.
+   - If the vulnerability is confirmed, I will prioritize creating a security
+     patch and release it as soon as possible.
+   - If the issue is not accepted or determined to be non-critical, I will
+     provide an explanation.
 
-Your help in improving the security of `SignalProcesserCPP` is greatly appreciated, and I will work diligently to resolve any issues you report.
+Your help in improving the security of `SignalProcesserCPP` is greatly
+appreciated, and I will work diligently to resolve any issues you report.