-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
108 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,147 @@ | ||
| <div align="center"> | ||
| <img src="icon.ico" alt="NeatShift Logo" width="128" height="128"> | ||
| <h1>NeatShift</h1> | ||
| <p>Organize your files without breaking anything</p> | ||
| <p>Keep your files organized, without losing track of them 🎯</p> | ||
| </div> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/BytexGrid/NeatShift/wiki">📚 Documentation</a> • | ||
| <a href="https://github.com/BytexGrid/NeatShift/releases">📦 Download</a> • | ||
| <a href="https://github.com/BytexGrid/NeatShift/issues">🐛 Report Bug</a> • | ||
| <a href="https://github.com/BytexGrid/NeatShift/issues">💡 Request Feature</a> | ||
| <a href="https://github.com/BytexGrid/NeatShift/wiki">📚 Learn More</a> • | ||
| <a href="https://github.com/BytexGrid/NeatShift/releases">📦 Download Now</a> • | ||
| <a href="https://github.com/BytexGrid/NeatShift/issues">🐛 Found a Bug?</a> • | ||
| <a href="https://github.com/BytexGrid/NeatShift/issues">💡 Share Ideas</a> | ||
| </p> | ||
|
|
||
| NeatShift is a modern Windows application that helps you organize files and folders while maintaining their accessibility through symbolic links. | ||
| <div align="center"> | ||
|
|
||
| NOTE : If you see some contradicting statement in readme or wiki , it is because I use LLMs as English is not my main language. So I request you to please dismiss such errors. Thank you! | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Screenshots | ||
| </div> | ||
|
|
||
| ### Light Mode | ||
|  | ||
| Hey there! 👋 Ever get frustrated with messy files scattered across your PC? Let me explain what NeatShift does with a real example: | ||
|
|
||
| ### Dark Mode | ||
|  | ||
| Imagine you have: | ||
| - Games in `C:\Games` (eating up your SSD space) | ||
| - Documents in `C:\Users\You\Documents` (getting cluttered) | ||
| - Downloads everywhere | ||
|
|
||
| ## Features | ||
| You want to move those huge game folders to your bigger HDD, but: | ||
| - Steam won't find the games anymore | ||
| - Shortcuts break | ||
| - File paths in your apps stop working | ||
|
|
||
| * 🔗 **Smart File Movement**: Move files while maintaining access through symbolic links | ||
| * 🛡️ **Safe Operations**: Automatic system restore point creation for safety | ||
| * 🎨 **Modern UI**: Clean Windows 11 style interface with dark/light theme support | ||
| * ⚡ **Drag and Drop**: Easy file and folder selection | ||
| * 🔍 **Link Management**: View and manage existing symbolic links | ||
| * ⚠️ **Error Prevention**: Smart validation and error handling | ||
| **That's where NeatShift comes in!** 🎮 | ||
|
|
||
| ## Installation | ||
| It lets you: | ||
| 1. Move those big game folders to `D:\Games` | ||
| 2. Creates magical links so everything still works | ||
| 3. Your PC thinks the files haven't moved at all! | ||
|
|
||
| ### For Users | ||
| Real-world uses: | ||
| - Move games to a different drive without breaking Steam | ||
| - Organize documents while keeping shortcuts working | ||
| - Clean up your SSD without breaking anything | ||
| - Keep your files organized YOUR way | ||
|
|
||
| 1. Download the latest release from the [Releases page](https://github.com/BytexGrid/NeatShift/releases) | ||
| 2. Choose either: | ||
| * `NeatShift.exe` (single file, larger size) | ||
| * `NeatShift-Release.zip` (compressed package) | ||
| 3. Run `NeatShift.exe` | ||
| * No installation needed | ||
| * No .NET runtime required (included in the package) | ||
| Think of it like creating shortcuts, but WAY more powerful - apps can't even tell the files moved! | ||
|
|
||
| ### For Developers | ||
| > **Note**: English isn't my first language, so you might spot some quirks in the documentation. Feel free to suggest improvements! | ||
| 1. Clone the repository: | ||
| ``` | ||
| git clone https://github.com/BytexGrid/NeatShift.git | ||
| ``` | ||
| 2. Open `NeatShift.sln` in Visual Studio 2022 | ||
| 3. Required tools: | ||
| * Visual Studio 2022 (any edition) | ||
| * .NET 6.0 SDK | ||
| * Windows SDK 10.0.19041.0 or later | ||
| 4. Build and run: | ||
| * Set `NeatShift` as startup project | ||
| * Build solution (F6) | ||
| * Run with debugging (F5) | ||
| ## ✨ See It In Action | ||
|
|
||
| ## Documentation | ||
| ### Light Mode - Clean & Crisp | ||
|  | ||
|
|
||
| Visit our [Wiki](https://github.com/BytexGrid/NeatShift/wiki) for detailed documentation: | ||
| - [Installation Guide](https://github.com/BytexGrid/NeatShift/wiki/Installation) | ||
| - [Usage Guide](https://github.com/BytexGrid/NeatShift/wiki/Usage-Guide) | ||
| - [Security & Verification](https://github.com/BytexGrid/NeatShift/wiki/Security-and-Verification) | ||
| - [FAQ](https://github.com/BytexGrid/NeatShift/wiki/FAQ) | ||
| ### Dark Mode - Easy on the Eyes | ||
|  | ||
|
|
||
| ## System Requirements | ||
| ## 🚀 What Makes NeatShift Special? | ||
|
|
||
| ### Minimum Requirements | ||
| * 🔗 **Smart Moving**: Move files anywhere, and NeatShift creates symbolic links so everything still works | ||
| * 🛡️ **Play it Safe**: Automatic system restore points, because better safe than sorry | ||
| * 🎨 **Looks Good, Feels Good**: Modern Windows 11 style with both light and dark themes | ||
| * ⚡ **Super Simple**: Just drag and drop your files - it's that easy | ||
| * 🔍 **Stay in Control**: See and manage all your symbolic links in one place | ||
| * ⚠️ **No Surprises**: Smart checks to prevent accidents before they happen | ||
|
|
||
| * Windows 7 SP1 or later | ||
| * Administrator privileges | ||
| * 100 MB free disk space | ||
| ## 🎯 Getting Started | ||
|
|
||
| ### Recommended | ||
| ### Just Want to Use It? | ||
| 1. Grab the latest version from our [Releases page](https://github.com/BytexGrid/NeatShift/releases) | ||
| 2. Pick your flavor: | ||
| * `NeatShift.exe` - One file, ready to go (bit larger) | ||
| * `NeatShift-Release.zip` - Zipped package (smaller download) | ||
| 3. Double-click and you're set! | ||
| * No installer headaches | ||
| * Everything's included - even the .NET stuff | ||
|
|
||
| * Windows 10/11 | ||
| * SSD for faster file operations | ||
| * System Restore enabled (for safety features) | ||
| ### Want to Tinker With the Code? | ||
|
|
||
| ## Administrator Privileges | ||
| 1. Get your copy: | ||
| ```bash | ||
| git clone https://github.com/BytexGrid/NeatShift.git | ||
| ``` | ||
| 2. Fire up Visual Studio 2022 | ||
| 3. You'll need: | ||
| * Visual Studio 2022 (any flavor works) | ||
| * .NET 6.0 SDK | ||
| * Windows SDK 10.0.19041.0+ | ||
| 4. Ready to roll: | ||
| * Set `NeatShift` as your startup | ||
| * Hit F6 to build | ||
| * F5 to see it in action | ||
|
|
||
| ## 📚 Learn More | ||
|
|
||
| Check out our [Wiki](https://github.com/BytexGrid/NeatShift/wiki) for all the details: | ||
| - [Getting Started Guide](https://github.com/BytexGrid/NeatShift/wiki/Installation) | ||
| - [How to Use](https://github.com/BytexGrid/NeatShift/wiki/Usage-Guide) | ||
| - [Safety First](https://github.com/BytexGrid/NeatShift/wiki/Security-and-Verification) | ||
| - [Common Questions](https://github.com/BytexGrid/NeatShift/wiki/FAQ) | ||
|
|
||
| ## 💻 What You'll Need | ||
|
|
||
| ### Bare Minimum: | ||
| * Windows 7 SP1 or newer | ||
| * Admin rights (for creating links) | ||
| * 100 MB of space | ||
|
|
||
| ### For the Best Experience: | ||
| * Windows 10/11 | ||
| * An SSD (because faster is better) | ||
| * System Restore turned on (just in case) | ||
|
|
||
| NeatShift requires administrator privileges for two essential functions: | ||
| ## 🔑 About Those Admin Rights | ||
|
|
||
| 1. **Creating Symbolic Links**: Windows security model requires elevated privileges to create symbolic links. This is a system-level security requirement to prevent potential misuse of links. | ||
| 2. **System Restore Points**: Creating system restore points requires access to system protection settings, which is only available with administrator rights. | ||
| NeatShift needs admin privileges for two things: | ||
|
|
||
| ## ⚠️ Important Disclaimer | ||
| 1. **Making Symbolic Links**: Windows is picky about who gets to create these | ||
| 2. **System Restore Points**: Better safe than sorry! | ||
|
|
||
| NeatShift is currently in testing phase. While we implement safety measures like automatic system restore points, please note: | ||
| ## ⚠️ Heads Up! | ||
|
|
||
| 1. **Manual Backups**: We strongly recommend creating manual system restore points or file backups before using the application | ||
| 2. **Testing Phase**: The application is under active development and testing | ||
| 3. **No Warranty**: The software is provided "as is", without warranty of any kind | ||
| 4. **User Responsibility**: Always verify symbolic links are working as expected after moving files | ||
| NeatShift is still young and growing. While I've added safety nets like automatic restore points: | ||
|
|
||
| ## Support | ||
| 1. **Back Up**: Maybe create a restore point yourself - just to be extra safe | ||
| 2. **Work in Progress**: We're actively improving things | ||
| 3. **No Guarantees**: It works on my machine(s), but you know how that goes | ||
| 4. **Double-Check**: Always verify your links work as expected | ||
|
|
||
| Need help or want to request a feature? | ||
| ## 🤝 Need a Hand? | ||
|
|
||
| * Check our [Wiki](https://github.com/BytexGrid/NeatShift/wiki) | ||
| * Create an [Issue](https://github.com/BytexGrid/NeatShift/issues) | ||
| Got questions or ideas? | ||
|
|
||
| ## License | ||
| * Browse our [Wiki](https://github.com/BytexGrid/NeatShift/wiki) | ||
| * [Open an Issue](https://github.com/BytexGrid/NeatShift/issues) - I read them all! | ||
|
|
||
| This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. | ||
| ## 📜 Legal Stuff | ||
|
|
||
| This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
| NeatShift is free software under the GNU General Public License v3.0. In simple terms: | ||
| - Use it however you like | ||
| - Share it with others | ||
| - Make it better | ||
| - Share your improvements | ||
|
|
||
| You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| [Full license details here](https://www.gnu.org/licenses/) |