Upload README.md

README.md

@@ -1,26 +1,46 @@
----
-tags:
-- ml-intern
----
+# FastSeek WPF
 
-# anshdadhich/finder-wpf
+A Windows-only WPF port of the FastSeek instant file search tool.
 
-<!-- ml-intern-provenance -->
-## Generated by ML Intern
+## Requirements
 
-This model repository was generated by [ML Intern](https://github.com/huggingface/ml-intern), an agent for machine learning research and development on the Hugging Face Hub.
+- Windows 10/11
+- .NET 8 SDK or later
+- Administrator privileges (required for NTFS MFT and USN journal access)
 
-- Try ML Intern: https://smolagents-ml-intern.hf.space
-- Source code: https://github.com/huggingface/ml-intern
+## Build
 
-## Usage
+```powershell
+cd FastSeekWpf
+dotnet publish -c Release -r win-x64 --self-contained false
+```
 
-```python
-from transformers import AutoModelForCausalLM, AutoTokenizer
+Or just run from source:
 
-model_id = "anshdadhich/finder-wpf"
-tokenizer = AutoTokenizer.from_pretrained(model_id)
-model = AutoModelForCausalLM.from_pretrained(model_id)
+```powershell
+cd FastSeekWpf
+dotnet run
 ```
 
-For non-causal architectures, replace `AutoModelForCausalLM` with the appropriate `AutoModel` class.
+**Must run as Administrator.** Right-click → Run as Administrator, or launch from an elevated PowerShell.
+
+## Usage
+
+- **Alt+Space** — toggle the search window
+- **Esc** — hide
+- **Up/Down** — navigate results
+- **Enter** — open selected file/folder
+- **Ctrl+Enter** — open containing folder
+- **Type** — search as you type (results update instantly)
+
+## Architecture
+
+The app reads the NTFS Master File Table (MFT) directly via `FSCTL_ENUM_USN_DATA` / direct `$MFT` read, builds an in-memory index, and keeps it in sync via the USN Change Journal. Search is name-only with fuzzy matching and type-based ranking.
+
+## Known Issues / TODO
+
+- [ ] The `SetWindowPos` + `AllowTransparency` combo doesn't give true rounded window corners on Windows 10 (use `DWMWA_WINDOW_CORNER_PREFERENCE` via P/Invoke for native DWM rounding)
+- [ ] `FindWindowW` class name matching may fail if WPF doesn't register the class; use window title or `HwndSource.AddHook` for inter-process toggle
+- [ ] The `ReadFile` P/Invoke for MFT direct read requires `FILE_FLAG_NO_BUFFERING` on some systems
+- [ ] `PeekMessageW` in a hotkey thread should use `GetMessageW` for lower CPU usage
+- [ ] Index store arena allocation during live updates (Insert/Remove) could be optimized with memory pooling instead of full reallocation