diff --git a/README.md b/README.md new file mode 100644 index 0000000..4ff66d4 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Windows Pathifier + +A simple Go tool to add/remove the current directory to/from the Windows PATH environment variable. + +## Features + +- Add current directory to Windows PATH +- Remove current directory from Windows PATH (undo functionality) +- Windows Explorer context menu integration +- Comprehensive logging with cylogger + +## Usage + +### Command Line + +```bash +# Add current directory to PATH +windows-pathifier.exe + +# Remove current directory from PATH +windows-pathifier.exe -u +``` + +### Context Menu Integration + +1. **Install**: Double-click `install_context_menu.reg` +2. **Use**: Right-click any folder → "Add to PATH" +3. **Uninstall**: Double-click `uninstall_context_menu.reg` + +## Building + +```bash +go build -o windows-pathifier.exe +``` + +## Requirements + +- Windows OS +- Go 1.23.6+ +- Administrator privileges (for registry modification)