init

README.md

@@ -0,0 +1,39 @@
+# monkeysucker
+
+This tool converts [WriteMonkey 3](https://github.com/writemonkey/wm3/) sheet files into markdown files.
+
+## Where the database files live
+
+WriteMonkey 3 stores its database files in the local application data directory:
+
+- Windows: `c:\Users\[user]\AppData\Local\Writemonkey 3\writemonkey3_sheets`
+- macOS: `/Users/[user]/Library/Application Support/Writemonkey 3/writemonkey3_sheets`
+- Linux: `/var/local/Writemonkey 3/writemonkey3_sheets`
+
+Additional files in the same folder:
+
+- `writemonkey3_sheets_repository` (snippets/repository)
+- `writemonkey3_sheets_history` (history/restore points)
+- `writemonkey3_sheets_projects` (projects)
+- `writemonkey3_custom_dictionary` (plain text)
+
+You can also open these folders from within WriteMonkey 3 via its command palette.
+
+## Usage
+
+```
+uv run --from git+https://codeberg.org/randogoth/monkeysucker ./monkeysucker.py path/to/datadir path/to/outputdir
+```
+
+## Output rules
+
+- One markdown file per document, named `yyyymmdd_sanitized_title.md` (UTC creation date).
+- Only the latest record per document id is exported.
+- YAML frontmatter includes `id`, `title`, `created`, and `modified` (UTC dates). Tags are included only when present.
+- If a document has snippets, a companion file is created with `_snippets` before the extension.
+- Documents are placed into project folders; otherwise they go to the output root.
+- File mtime is set to the document's modified time.
+
+## Notes
+
+- The output directory is deleted and recreated on each run.