# GeViScope & GeViSoft SDK Markdown Archive

This folder now contains Markdown-friendly extracts of the original SDK documentation so it can be chunked or consumed by language models without needing to parse PDF/HTML files. Every `.md` file begins with a short provenance note and then preserves the page order from the source.

## Available documents

### GeViScope
- `GeViScope/GeViScope_SDK.md` — main SDK guide converted from `GeViScope_SDK.pdf`.
- `GeViScope/GeviScope_SDK_html.md` — HTML dump of `GeviScope_SDK.htm` via `w3m -dump`; useful if you prefer the help version of the guide.
- `GeViScope/Additional documentation/GscActionsOverview_EN.md` — conceptual overview of GSC actions.
- `GeViScope/Additional documentation/GscActionsReference_EN.md` — reference for every action and parameter.
- `GeViScope/Additional documentation/Installation_GscStreamer_en.md` — installation instructions for the streamer component.
- `GeViScope/Additional documentation/TACI - Telnet Action Command Interface.md` — Telnet command reference for the TACI interface.

### GeViSoft
- `GeViSoft/GeViSoft_SDK_Documentation.md` — developer guide converted from `GeViSoft_SDK_Documentation.pdf`.

## Working with the Markdown files
- The text was produced with `pdftotext -layout` (and `w3m -dump` for HTML) to preserve columns and tables; expect monospace formatting for diagrams/tables.
- Because the PDFs were flattened to text, embedded images are not available. Keep the original PDFs nearby if you need diagrams.
- Chunking for LLMs generally works best by splitting on headings (lines that start with `#`, `##`, etc.) or large blank-line gaps.

## To-do / limitations
- The `.chm` help files and the full `GeViScopeSDK_HTML5` site remain in their original formats. Converting them requires CHM/HTML tooling (e.g., `chmextract` + `pandoc`). Let me know if you want those processed as well.