Skip to content

Commit 816a512

Browse files
Expand AGENTS.md with additional notes
1 parent fa72395 commit 816a512

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

CPlusPlus/AGENTS.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,14 @@
33
## Project Structure & Module Organization
44
- `CMakeLists.txt`: CMake config (C++20 target).
55
- `main.cpp`: entry point and sample scaffold.
6+
- `Endpoint Examples/JSON Payload/markdown.cpp`: JSON two‑step upload → markdown.
7+
- `Endpoint Examples/JSON Payload/rasterized_pdf.cpp`: JSON two‑step upload → rasterized-pdf.
8+
- `Endpoint Examples/Multipart Payload/markdown.cpp`: Multipart markdown (file + options).
9+
- `Endpoint Examples/Multipart Payload/rasterized_pdf.cpp`: Multipart rasterized-pdf (file only).
10+
- `Complex Flow Examples/merge_different_file_types.cpp`: Convert different types to PDF, then merge.
11+
- `.env.example` → copy to `.env` (loaded automatically).
612
- `build/` or `cmake-build-*`: local build output (untracked).
7-
- New samples: mirror repo layout when relevant (`Endpoint Examples/JSON Payload/` vs `Endpoint Examples/Multipart Payload/`). Name files after endpoints (e.g., `markdown.cpp`).
13+
- New samples: mirror repo layout (`Endpoint Examples/JSON Payload/`, `Endpoint Examples/Multipart Payload/`). Name files after endpoints.
814

915
## Build, Test, and Development Commands
1016
- Install deps via vcpkg (pick one HTTP client):
@@ -45,6 +51,9 @@ target_link_libraries(CPlusPlus PRIVATE nlohmann_json::nlohmann_json cpr::cpr)
4551
- Optional cleanup: respect `PDFREST_DELETE_SENSITIVE_FILES=true` when implemented.
4652
- Respect proxies via `HTTPS_PROXY`/`HTTP_PROXY`. Never print API keys.
4753

54+
Note on `.env` loading
55+
- The C++ samples auto-load `.env` from this folder or the parent folder using a small manual parser — no extra packages required.
56+
4857
## Sample Header Template
4958
Place this at the top of each sample (before includes):
5059
```
@@ -57,8 +66,7 @@ Place this at the top of each sample (before includes):
5766
* - Optional: set PDFREST_URL (EU/GDPR: https://eu-api.pdfrest.com)
5867
* More info: https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
5968
*
60-
* Usage: ./CPlusPlus <args>
69+
* Usage: ./markdown_json <input.pdf>
6170
* Output: JSON to stdout; non‑2xx exits with concise error.
6271
*/
6372
```
64-

0 commit comments

Comments
 (0)