From f9898cbdac03da1da00475f8ce4997000b525470 Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Sat, 24 May 2025 22:02:40 -0400 Subject: [PATCH] Document forward-slash paths --- README.md | 11 ++++++++++- docs/adr/DP-003_file-watcher_lifecycle.md | 1 + 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c54ef8..b3bf0f8 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,16 @@ for the current delivery roadmap and schema. Follow the short walkthrough in [docs/marlin_demo.md](docs/marlin_demo.md) to build the -binary and test Marlin on a sample project. +binary and test Marlin on a sample project. Paths in the +database are always stored with forward slashes (`/`), even +on Windows. + +```powershell +# PowerShell build example +$env:CARGO_TARGET_DIR = "target" +cargo build --release +Copy-Item target\release\marlin.exe C:\Tools\marlin.exe +``` ## CLI Cheatsheet diff --git a/docs/adr/DP-003_file-watcher_lifecycle.md b/docs/adr/DP-003_file-watcher_lifecycle.md index 24876a6..8c28f51 100644 --- a/docs/adr/DP-003_file-watcher_lifecycle.md +++ b/docs/adr/DP-003_file-watcher_lifecycle.md @@ -33,6 +33,7 @@ We'll implement a file-watcher system using the `notify` crate (which uses inoti - Batch database operations to minimize write transactions - Use the `--dirty` flag internally to optimize updates for changed files only - Implement a "catchup scan" on startup to handle changes that occurred while not watching + - Normalize all stored paths to use forward slashes (`/`) for portability 4. **Backup & Pruning**: - Add `backup --prune N` to maintain only the N most recent backups