# [Project Name]

<!--
Template instructions:
1. Copy this file to the root of the new project.
2. Rename the copy README.md.
3. Replace bracketed text and remove sections that do not apply.
4. Write this file for a person encountering the project for the first time.
-->

[One or two sentences explaining what the project does and why it is useful.]

## Audience

This project is intended for [engineers, scientists, students, educators,
maintainers, or another audience].

Readers should be familiar with [required background]. The examples explain
[topics for which prior knowledge is not required].

## Project Goals

- [Primary technical or educational goal]
- [Secondary goal]
- [What the project intentionally does not attempt]

## Requirements

### Software

- MATLAB [release or minimum release]
- [Required toolboxes, or “No additional toolboxes required”]
- [Operating-system or driver requirement]

### Hardware

<!-- Delete this subsection when hardware is not required. -->

- [Instrument or device and model]
- [Cables, probes, fixtures, or circuit]
- [Network, USB, serial, or other connection]

## Safety and Measurement Limits

<!-- Delete or adapt this section when it does not apply. -->

- Verify [voltage, current, frequency, loading, or power limits].
- Confirm instrument output impedance and measurement termination.
- Begin with outputs disabled.
- [Add experiment-specific precautions.]

## Quick Start

1. Download or clone the complete project.
2. Open [MATLAB project file or project root directory].
3. Configure [IP address, port, file path, sample rate, or other inputs] in
   `[configuration file or script]`.
4. Connect or prepare [hardware/data].
5. Run `[main_script.m]`.
6. Confirm [expected command-window message, plot, measurement, or output].

## Configuration

| Setting | Meaning | Example |
| --- | --- | --- |
| `[settingName]` | [Description] | `[value]` |
| `[settingName]` | [Description] | `[value]` |

## Main Files

- `[main_script.m]`: [purpose]
- `[helper_function.m]`: [purpose]
- `[data or configuration file]`: [purpose]
- `AGENTS.md`: durable project instructions for Codex.
- `[reference or documentation file]`: [purpose]

## Workflow

1. [First major operation]
2. [Validation or computation]
3. [Hardware action, simulation, or analysis]
4. [Result generation]
5. [Cleanup or shutdown behavior]

## Expected Results

Running `[main_script.m]` should produce:

- [Expected command-window output]
- [Expected plot or data product]
- [Expected hardware behavior]

[Include a representative image, plot, or abbreviated output when helpful.]

## Using This Project With an AI Coworker

Keep `AGENTS.md` at the project root. Codex reads that file as project
guidance when a new task starts from this directory.

A useful first prompt is:

> Work in this project folder and follow the root `AGENTS.md`. Read this
> `README.md`, inspect the existing files, and consult the reference index
> when relevant. I want to [describe the desired result].

For an AI system that does not automatically recognize `AGENTS.md`, begin
with:

> Before working, read `AGENTS.md` and `README.md` in the project root.

The AI should retrieve only the reference sections relevant to the current
task rather than loading an entire large library.

## User-Directed Experimental Loop

[Name the workflow if the project uses a named method.] In this loop, curated
technical references inform the code; execution occurs under user direction;
system read-back and independent evidence evaluate the result; and validated
findings improve the code and guidance used in the next cycle.

When adding a reference from the project author or another contributor:

1. Confirm permission to include or link it.
2. Record its source, attribution, and reuse terms.
3. Index only the sections relevant to likely project work.
4. Preserve distinctive techniques in the project's methods guide.
5. Validate a technique in an actual project before recording it as a project
   lesson.

Access to applications, network instruments, and displays is session-specific
and user-authorized. Project documentation provides operating guidance; it
does not itself grant computer-control or hardware access.

## Reference Material

<!-- Delete this section when the project has no bundled references. -->

- `[reference-index.md]`: [coverage]
- `[methods-guide.md]`: [coverage]
- `[source document]`: [coverage and attribution]

## Known Limitations

- [Hardware, software, validation, or portability limitation]
- [Known behavior that may surprise users]
- [Feature intentionally left for future work]

## Project Status

[Experimental demonstration / active research / maintained release /
archived educational example]

## Attribution and License

Project author: [name]

Acknowledgements: [instructors, collaborators, data providers, or sources]

License: [license name or “Not yet specified”]

Third-party material retains its original attribution and publication terms.
