Update readme and add github pages

yani- · Jan 11, 2025 · 359ee96 · 359ee96
1 parent b5225ed
commit 359ee96
Show file tree

Hide file tree

Showing 5 changed files with 171 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -1,44 +1,57 @@
-# NFS Drive Manager
+# Windows NFS Manager
 
-A simple GUI application for Windows to manage NFS drives. Features include:
-- Mount NFS drives
-- Unmount drives
-- View drive properties
-- Real-time status monitoring
+A simple GUI application for managing NFS drives on Windows.
 
-## Requirements
-- Python 3.x
-- Windows with NFS Client feature enabled
+![NFS Manager](docs/application.png)
 
-## Setup
+## Features
+- 🔌 Easy mounting of NFS drives through a graphical interface
+- ⚙️ Advanced mount settings configuration
+- 📊 Real-time drive status and properties monitoring
+- 🛡️ Safe unmounting of drives
 
-1. Install required Python packages:
+## Quick Start
+
+### Option 1: Download Executable
+1. Download the [latest release](https://github.com/yani-/windows-nfs-manager/releases/latest)
+2. Enable Windows NFS Client feature if not already enabled
+3. Run the application
+
+### Option 2: Build from Source
+1. Clone the repository
+2. Install requirements:
 ```bash
 pip install -r requirements.txt
 ```
+3. Run the application:
+```bash
+python nfs_manager.py
+```
 
-2. Enable Windows NFS Client feature:
-   - Open "Control Panel"
-   - Go to "Programs and Features"
-   - Click "Turn Windows features on or off"
-   - Check "Services for NFS" and its sub-components
-   - Click OK and restart if prompted
+## Setup Windows NFS Client
+
+1. Open "Control Panel"
+2. Go to "Programs and Features"
+3. Click "Turn Windows features on or off"
+4. Check "Services for NFS" and its sub-components
+5. Click OK and restart if prompted
 
 ## Usage
 
-1. Run the application:
-```bash
-python nfs_manager.py
-```
+1. Enter the NFS server address (e.g., 192.168.1.100)
+2. Enter the share path (e.g., /exports/share1)
+3. Select a drive letter
+4. (Optional) Configure mount settings via the ⚙️ button
+5. Click "Mount"
+
+## Mount Settings
 
-2. To mount an NFS drive:
-   - Enter the server address (e.g., 192.168.1.100)
-   - Enter the share path (e.g., /exports/share1)
-   - Select a drive letter
-   - Click "Mount"
+- User/Group IDs: Match with NFS server permissions
+- Transfer Sizes: Larger = better performance (if stable)
+- Timeout: Lower = faster reconnect on issues
+- File Access: 755 = standard read/write/execute
+- Soft Mount: Recommended for better reliability
 
-3. To unmount a drive:
-   - Select the drive from the list
-   - Click "Unmount Selected"
+## More Information
 
-4. View properties by selecting a drive from the list 
+Visit our [project page](https://yani-.github.io/windows-nfs-manager/) for detailed documentation and screenshots. 
diff --git a/docs/application.png b/docs/application.png
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,128 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Windows NFS Manager</title>
+    <style>
+        body {
+            font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
+            line-height: 1.6;
+            max-width: 1200px;
+            margin: 0 auto;
+            padding: 20px;
+            color: #333;
+        }
+        .header {
+            text-align: center;
+            margin-bottom: 40px;
+        }
+        .download-button {
+            display: inline-block;
+            background-color: #2ecc71;
+            color: white;
+            padding: 12px 24px;
+            text-decoration: none;
+            border-radius: 4px;
+            font-weight: bold;
+            margin: 20px 0;
+        }
+        .download-button:hover {
+            background-color: #27ae60;
+        }
+        .features {
+            display: grid;
+            grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
+            gap: 20px;
+            margin: 40px 0;
+        }
+        .feature {
+            background: #f8f9fa;
+            padding: 20px;
+            border-radius: 8px;
+            box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+        }
+        .screenshots {
+            margin: 40px 0;
+        }
+        .screenshot {
+            margin: 20px 0;
+            text-align: center;
+        }
+        .screenshot img {
+            max-width: 100%;
+            border-radius: 8px;
+            box-shadow: 0 4px 8px rgba(0,0,0,0.1);
+        }
+        .caption {
+            margin-top: 10px;
+            font-style: italic;
+            color: #666;
+        }
+    </style>
+</head>
+<body>
+    <div class="header">
+        <h1>Windows NFS Manager</h1>
+        <p>A simple GUI application for managing NFS drives on Windows</p>
+        <a href="https://github.com/yani-/windows-nfs-manager/releases/download/v1.0.0/NFS-Manager.exe" class="download-button">
+            Download Latest Version (v1.0.0)
+        </a>
+    </div>
+
+    <div class="features">
+        <div class="feature">
+            <h3>🔌 Easy Mounting</h3>
+            <p>Mount NFS drives with a simple interface. No command line needed!</p>
+        </div>
+        <div class="feature">
+            <h3>⚙️ Advanced Settings</h3>
+            <p>Configure mount options like UID, GID, transfer sizes, and more through a user-friendly settings dialog.</p>
+        </div>
+        <div class="feature">
+            <h3>📊 Drive Management</h3>
+            <p>View and manage all mounted NFS drives in one place. See status, usage, and detailed properties.</p>
+        </div>
+        <div class="feature">
+            <h3>🔄 Real-time Updates</h3>
+            <p>Monitor drive status and storage usage with real-time updates.</p>
+        </div>
+        <div class="feature">
+            <h3>🛡️ Safe Unmounting</h3>
+            <p>Safely unmount drives with a single click.</p>
+        </div>
+        <div class="feature">
+            <h3>📝 Detailed Properties</h3>
+            <p>View comprehensive drive properties including space usage, mount settings, and connection details.</p>
+        </div>
+    </div>
+
+    <div class="screenshots">
+        <h2>Screenshots</h2>
+
+        <div class="screenshot">
+            <img src="application.png" alt="Main Application Window">
+            <div class="caption">Main application window showing mount options and drive list</div>
+        </div>
+
+        <div class="screenshot">
+            <img src="mounted.png" alt="Mounted Drive View">
+            <div class="caption">View of mounted drives with detailed properties</div>
+        </div>
+
+        <div class="screenshot">
+            <img src="settings.png" alt="Mount Settings Dialog">
+            <div class="caption">Advanced mount settings configuration</div>
+        </div>
+    </div>
+
+    <div class="setup">
+        <h2>Setup</h2>
+        <ol>
+            <li>Download the latest version</li>
+            <li>Make sure Windows NFS Client feature is enabled (Control Panel → Programs → Turn Windows features on or off → Services for NFS)</li>
+            <li>Run the application and start managing your NFS drives!</li>
+        </ol>
+    </div>
+</body>
+</html> 
diff --git a/docs/mounted.png b/docs/mounted.png
diff --git a/docs/settings.png b/docs/settings.png