Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions SDDSlib/doc/AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Documentation Style Guide

This directory contains Markdown files for the SDDS library.

- Use Markdown with fenced code blocks for commands and paths.
- Indent using two spaces; avoid tabs.
- Wrap lines at a reasonable length (~100 characters).
- Reference source files and directories with relative paths.


24 changes: 24 additions & 0 deletions SDDSlib/doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# SDDS Library Documentation

This directory contains documentation for the core SDDS C/C++ library.

## Building

From the repository root or within `SDDSlib`:

```bash
make -j
```

The build generates the static library at `lib/<OS>-<ARCH>/libSDDS1.a`.

## Usage

Include headers from the `include/` directory and link against `libSDDS1.a`.
See the sample programs in `SDDSlib/demo` for basic reading and writing
examples.

Source files contain Doxygen-style comments that can be processed with tools
like `doxygen` to produce API references. Additional documents can be added
here to expand the library documentation.