Merge pull request #83 from PR0M3TH3AN/codex/update-documentation-for-paths-and-powershell

Update docs about path slashes
This commit is contained in:
thePR0M3TH3AN
2025-05-24 22:02:56 -04:00
committed by GitHub
2 changed files with 11 additions and 1 deletions

View File

@@ -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

View File

@@ -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