chore: Update dependencies and documentation

LyubomirT · Jul 26, 2024 · ec413ef · ec413ef
1 parent 45550a5
commit ec413ef
Show file tree

Hide file tree

Showing 9 changed files with 279 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -26,4 +26,6 @@ This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE)
 
 ## Acknowledgements 🙏
 
-- [PyQt5](https://pypi.org/project/PyQt5/)
+- [PyQt5](https://pypi.org/project/PyQt5/)
+- [PyInstaller](https://pypi.org/project/pyinstaller/)
+- [PyAutoGUI](https://pypi.org/project/PyAutoGUI/)
diff --git a/docs/acknowledgements.html b/docs/acknowledgements.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Acknowledgements - Chainsaw Human Typing</title>
+    <link rel="stylesheet" href="style.css">
+</head>
+<body>
+    <div class="container">
+        <h1>Acknowledgements</h1>
+        <div class="section">
+            <p>We would like to acknowledge the following resources and libraries that contributed to the development of Chainsaw Human Typing:</p>
+            <ul>
+                <li><a href="https://pypi.org/project/PyQt5/">PyQt5</a> - A library for creating graphical user interfaces in Python.</li>
+                <li><a href="https://github.com/sylvainmetayer/pyautogui">PyAutoGUI</a> - A library used for simulating keyboard input.</li>
+            </ul>
+        </div>
+        <a href="index.html">Back to Home</a>
+    </div>
+    <script src="script.js"></script>
+</body>
+</html>
diff --git a/docs/contributing.html b/docs/contributing.html
@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Contributing - Chainsaw Human Typing</title>
+    <link rel="stylesheet" href="style.css">
+</head>
+<body>
+    <div class="container">
+        <h1>Contributing to Chainsaw Human Typing</h1>
+        <div class="section">
+            <p>We welcome contributions to Chainsaw Human Typing! Here’s how you can contribute:</p>
+            <ol>
+                <li><strong>Fork the Repository:</strong> Create a fork of the repository on GitHub to make your changes.</li>
+                <li><strong>Clone Your Fork:</strong> Clone your forked repository to your local machine:
+                    <pre><code>git clone https://github.com/your-username/chainsaw-human-typing.git</code></pre>
+                </li>
+                <li><strong>Create a Branch:</strong> Create a new branch for your changes:
+                    <pre><code>git checkout -b my-feature-branch</code></pre>
+                </li>
+                <li><strong>Make Changes:</strong> Implement your changes or fixes. Ensure that your code adheres to the existing coding standards and practices.</li>
+                <li><strong>Commit Your Changes:</strong> Commit your changes with a descriptive message:
+                    <pre><code>git add .
+git commit -m "Add feature X or fix issue Y"</code></pre>
+                </li>
+                <li><strong>Push Changes:</strong> Push your changes to your forked repository:
+                    <pre><code>git push origin my-feature-branch</code></pre>
+                </li>
+                <li><strong>Open a Pull Request:</strong> Go to the original repository on GitHub and open a pull request. Provide a clear description of your changes.</li>
+                <li><strong>Review Process:</strong> Your pull request will be reviewed. If everything is satisfactory, it will be merged into the main repository.</li>
+            </ol>
+            <p>If you have any questions or need help, feel free to open an issue or contact the maintainers.</p>
+        </div>
+        <a href="index.html">Back to Home</a>
+    </div>
+    <script src="script.js"></script>
+</body>
+</html>
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Chainsaw Human Typing Documentation</title>
+    <link rel="stylesheet" href="style.css">
+</head>
+<body>
+    <div class="container">
+        <h1>Chainsaw Human Typing Documentation</h1>
+        <div class="section">
+            <p>Welcome to the Chainsaw Human Typing documentation. This guide will help you understand how to use the app, run it from the source, and contribute to its development.</p>
+        </div>
+        <div class="section">
+            <h2><span class="emoji">📝</span>Table of Contents</h2>
+            <ul>
+                <li><a href="usage.html">How to Use the App</a></li>
+                <li><a href="run-from-source.html">Running from Source</a></li>
+                <li><a href="contributing.html">Contributing</a></li>
+                <li><a href="license.html">License</a></li>
+                <li><a href="acknowledgements.html">Acknowledgements</a></li>
+            </ul>
+        </div>
+    </div>
+    <script src="script.js"></script>
+</body>
+</html>
diff --git a/docs/license.html b/docs/license.html
@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>License - Chainsaw Human Typing</title>
+    <link rel="stylesheet" href="style.css">
+</head>
+<body>
+    <div class="container">
+        <h1>License</h1>
+        <div class="section">
+            <p>The Chainsaw Human Typing project is licensed under the <strong>GPL-3.0 License</strong>. Below is the full text of the license:</p>
+            <pre><code>
+                GNU GENERAL PUBLIC LICENSE
+                Version 3, 29 June 2007
+
+                Copyright (C) 2007 Free Software Foundation, Inc.
+                <address>51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA</address>
+                Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+                [The full license text would go here.]
+            </code></pre>
+            <p>For more details, please refer to the LICENSE file in the project repository.</p>
+        </div>
+        <a href="index.html">Back to Home</a>
+    </div>
+    <script src="script.js"></script>
+</body>
+</html>
diff --git a/docs/run-from-source.html b/docs/run-from-source.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Run from Source - Chainsaw Human Typing</title>
+    <link rel="stylesheet" href="style.css">
+</head>
+<body>
+    <div class="container">
+        <h1>Running Chainsaw Human Typing from Source</h1>
+        <div class="section">
+            <p>To run Chainsaw Human Typing from the source code, follow these instructions:</p>
+            <ol>
+                <li><strong>Install Python:</strong> Ensure you have Python 3.6 or higher installed on your system. You can download Python from the <a href="https://www.python.org/downloads/">official Python website</a>.</li>
+                <li><strong>Clone the Repository:</strong> Clone the repository using Git. Open your terminal and run:
+                    <pre><code>git clone https://github.com/your-repo/chainsaw-human-typing.git</code></pre>
+                </li>
+                <li><strong>Install Dependencies:</strong> Navigate to the project directory and install the required dependencies:
+                    <pre><code>pip install -r requirements.txt</code></pre>
+                </li>
+                <li><strong>Run the Application:</strong> Execute the main script to start the application:
+                    <pre><code>python main.py</code></pre>
+                </li>
+                <li><strong>Build the Application:</strong> To build the application into an executable, you can use PyInstaller. Run the PowerShell script provided:
+                    <pre><code>.\build.ps1</code></pre>
+                    This will create an executable in the <code>dist</code> folder.</li>
+            </ol>
+        </div>
+        <a href="index.html">Back to Home</a>
+    </div>
+    <script src="script.js"></script>
+</body>
+</html>
diff --git a/docs/script.js b/docs/script.js
@@ -0,0 +1,19 @@
+document.addEventListener('DOMContentLoaded', () => {
+    const sections = document.querySelectorAll('.section');
+
+    const observer = new IntersectionObserver((entries) => {
+        entries.forEach(entry => {
+            if (entry.isIntersecting) {
+                entry.target.style.opacity = '1';
+                entry.target.style.transform = 'translateX(0)';
+            }
+        });
+    }, { threshold: 0.1 });
+
+    sections.forEach(section => {
+        section.style.opacity = '0';
+        section.style.transform = 'translateX(-20px)';
+        section.style.transition = 'opacity 0.5s ease, transform 0.5s ease';
+        observer.observe(section);
+    });
+});
diff --git a/docs/style.css b/docs/style.css
@@ -0,0 +1,70 @@
+@import url('https://fonts.googleapis.com/css2?family=Poppins:wght@300;400;600&display=swap');
+
+body {
+    font-family: 'Poppins', sans-serif;
+    line-height: 1.6;
+    color: #333;
+    background: linear-gradient(135deg, #f5f7fa 0%, #c3cfe2 100%);
+    margin: 0;
+    padding: 0;
+}
+
+.container {
+    max-width: 800px;
+    margin: 0 auto;
+    padding: 2rem;
+}
+
+h1, h2 {
+    color: #2c3e50;
+}
+
+h1 {
+    font-size: 2.5rem;
+    margin-bottom: 1rem;
+}
+
+h2 {
+    font-size: 1.8rem;
+    margin-top: 2rem;
+}
+
+p, ul {
+    margin-bottom: 1rem;
+}
+
+a {
+    color: #3498db;
+    text-decoration: none;
+    transition: color 0.3s ease;
+}
+
+a:hover {
+    color: #2980b9;
+}
+
+.section {
+    background-color: rgba(255, 255, 255, 0.8);
+    border-radius: 10px;
+    padding: 1.5rem;
+    margin-bottom: 2rem;
+    box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);
+    transition: transform 0.3s ease, box-shadow 0.3s ease;
+}
+
+.section:hover {
+    transform: translateY(-5px);
+    box-shadow: 0 6px 8px rgba(0, 0, 0, 0.15);
+}
+
+.emoji {
+    font-size: 1.5rem;
+    margin-right: 0.5rem;
+}
+
+code {
+    background-color: #f0f0f0;
+    padding: 0.2rem 0.4rem;
+    border-radius: 4px;
+    font-family: 'Courier New', Courier, monospace;
+}
diff --git a/docs/usage.html b/docs/usage.html
@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Usage - Chainsaw Human Typing</title>
+    <link rel="stylesheet" href="style.css">
+</head>
+<body>
+    <div class="container">
+        <h1>How to Use Chainsaw Human Typing</h1>
+        <div class="section">
+            <p>Chainsaw Human Typing is designed to simulate human typing in various scenarios. Follow these steps to effectively use the application:</p>
+            <ol>
+                <li><strong>Open the Application:</strong> Launch the application from your desktop or start menu. You will be greeted with the main interface of the application.</li>
+                <li><strong>Enter Text:</strong> In the main window, you will see a text area where you can type or paste the text you want to simulate. This text will be used by the application to simulate typing.</li>
+                <li><strong>Configure Settings:</strong> Below the text area, you can configure several settings:
+                    <ul>
+                        <li><strong>Delay:</strong> Set the delay in seconds before starting the typing simulation.</li>
+                        <li><strong>Interval:</strong> Set the interval between keystrokes. This determines how fast the typing simulation occurs.</li>
+                        <li><strong>Chars per Stroke:</strong> Choose the number of characters to type at a time before pausing.</li>
+                        <li><strong>Type Enter:</strong> If checked, the application will simulate pressing the Enter key when it encounters newline characters in the text.</li>
+                    </ul>
+                </li>
+                <li><strong>Start Typing:</strong> Click the "Start Typing" button to begin the simulation. The progress will be shown in the progress bar.</li>
+                <li><strong>Stop Typing:</strong> If you wish to stop the simulation, click the "Stop Typing" button. This will halt the typing process immediately.</li>
+            </ol>
+        </div>
+        <a href="index.html">Back to Home</a>
+    </div>
+    <script src="script.js"></script>
+</body>
+</html>