Merge pull request #82 from nomandhoni-cs/master

Final Releasing Blink Eye v1.8.0

.github/workflows/Auto Draft Release.yml

@@ -86,6 +86,7 @@ jobs:
         releaseDraft: true
         prerelease: false
         includeUpdaterJson: true
+        updaterJsonPreferNsis: true
         args: ${{ matrix.args }}
 
     - name: Upload release artifacts

.github/workflows/Release.yml

@@ -89,6 +89,7 @@ jobs:
         releaseDraft: true
         prerelease: false
         includeUpdaterJson: true
+        updaterJsonPreferNsis: true
         args: ${{ matrix.args }}
 
     - name: Upload release artifacts

CONTRIBUTING.md

@@ -16,7 +16,104 @@ If you would like to contribute to Blink Eye, please follow these steps:
 
 Thank you for your interest in contributing to Blink Eye! Your contributions help make Blink Eye a more effective and efficient tool for promoting eye health.
 
-## How to Use
+# Contribution Guide
+
+Contributions are welcome! Feel free to open issues or submit pull requests.
+
+Contributions for improving the dashboard, enhancing customizability, and adding new languages for multilingual support are particularly appreciated.
+
+### How to Contribute:
+
+1. **Fork** the repository to your GitHub account.
+
+2. **Clone** the repository to your local machine:
+   ```console
+   git clone https://github.com/your-username/blink-eye.git
+   ```
+3. **Create a new branch** for your changes:
+   ```console
+   git checkout -b my-branch
+   ```
+4. **Make changes** to the code.
+
+5. **Commit** your changes:
+   ```console
+   git commit -m "commit message"
+   ```
+6. **Push** your changes to the remote repository:
+   ```console
+   git push origin my-branch
+   ```
+7. **Create a pull request** on GitHub.
+
+
+## Application Setup
+
+### Prerequisites
+
+1. **Tauri** (for building the desktop app)
+4. **Rust** (for building the desktop app)
+3. **Cargo** (for package management)
+2. **Bun** (for package management)
+
+### To build and run Blink Eye (Desktop App):
+1. **Install JavaScript dependencies:**
+
+    ```console
+    bun install
+    ```
+
+2. **Change Directory:**
+
+    ```console
+    cd src-tauri
+    ```
+
+3. **Install all Cargo dependencies:**
+
+    ```console
+    cargo install
+    ```
+3. **Change Directory:**
+
+    ```console
+    cd ..
+    ```
+4. **Run the app in development mode:**
+
+    ```console
+    bun run tauri dev
+    ```
+
+## Website Setup
+
+### Prerequisites
+
+3. **Node JS** (for package management)
+2. **Bun** (for package management)
+
+### To build and run Blink Eye (Desktop App):
+
+1. **Change Directory:**
+
+    ```console
+    cd website
+    ```
+1. **Install dependencies:**
+
+    ```console
+    bun install
+    ```
+
+2. **Run the website in development mode:**
+
+    ```console
+    bun run dev
+    ```
+
+
+
+<!-- ## How to Use
 
 Here's how to get started with Blink Eye:
 
@@ -111,7 +208,7 @@ If you want to contribute by adding or improving the translation of a new or exi
         },
        ...
     }
-    ```
+    ``` -->
     
 ## Contributing to the Website
 

LICENSE.txt

@@ -1,21 +1,18 @@
-MIT License
+GNU General Public License (GPL) v3  
++ Additional Commercial Use Restrictions
 
 Copyright (c) 2024 Noman Dhoni
 
-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:
+This software is licensed under the GNU General Public License v3.0 (GPL-3.0), which permits anyone to use, modify, and distribute this software. However, the following additional conditions apply:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. Non-Commercial Use
+   - You may freely use, copy, modify, and distribute the software for non-commercial purposes only. Any use for commercial purposes (including but not limited to selling the software, incorporating it into a product that is sold, or using it in any way for profit) requires written permission from the original author ([Your Name]).
 
-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.
+2. Commercial Use
+   - To use this software commercially (including any derivative works), you must obtain a separate commercial license from the author. Commercial use without such a license is prohibited.
+
+3. Modifications and Contributions
+   - You are free to modify and contribute to this software under the terms of the GPL-3.0 license, but any changes or contributions must remain open-source and licensed under the same GPL-3.0 license.
+
+4. Warranty Disclaimer
+   - This software is provided "as is", without any 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.