Skip to content

Commit fce3c88

Browse files
committed
Migrate to AGENTS.md
1 parent 5c488c0 commit fce3c88

3 files changed

Lines changed: 21 additions & 8 deletions

File tree

‎.Rbuildignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
^\.cache$
66
^README\.Rmd$
77
^\.github$
8-
^CLAUDE\.md$
8+
^AGENTS\.md$
9+
^\.posit$
910
^_pkgdown\.yml$
1011
^dev$
1112
^docs$

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ src/symbols.rds
1010
.Rproj.user/
1111
*.Rproj
1212
compile_commands.json
13+
.posit/
1314
# pkgdown
1415
docs/
1516
# Claude Code

CLAUDE.md renamed to AGENTS.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1-
# CLAUDE.md
1+
# AGENTS.md
22

3-
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
3+
Guidance for AI coding agents working **on** the mori package. mori — Shared Memory for R Objects. Uses POSIX shared memory (Linux, macOS) and Win32 file mappings (Windows) with R's ALTREP framework to let multiple processes on the same machine read the same physical memory pages. No external dependencies. Requires R >= 4.3.0 (for ALTLIST). API: `share()` → ALTREP shared object, `map_shared()` → open SHM by name, `shared_name()` → extract identifier, `is_shared()` → test if shared, `prune_shared()` → remove orphaned regions of dead processes. ALTREP serialization hooks emit the `shared_name()` identifier as the wire form — transparent under `serialize()` and `mirai`.
44

5-
## Overview
5+
Claude Code users: add `.claude/CLAUDE.md` containing `@../AGENTS.md` to import this file (`.claude/` is gitignored).
66

7-
mori — Shared Memory for R Objects. Uses POSIX shared memory (Linux, macOS) and Win32 file mappings (Windows) with R's ALTREP framework to let multiple processes on the same machine read the same physical memory pages. No external dependencies. Requires R >= 4.3.0 (for ALTLIST). API: `share()` → ALTREP shared object, `map_shared()` → open SHM by name, `shared_name()` → extract identifier, `is_shared()` → test if shared, `prune_shared()` → remove orphaned regions of dead processes. ALTREP serialization hooks emit the `shared_name()` identifier as the wire form — transparent under `serialize()` and `mirai`.
7+
## Commands
88

9-
## Development Commands
9+
```r
10+
devtools::test() # full suite (testthat ed 3)
11+
testthat::test_file("tests/testthat/test-nested.R") # single test file
12+
devtools::document() # roxygen2 -> man/, NAMESPACE
13+
rmarkdown::render("README.Rmd") # rebuild README.md
14+
```
15+
16+
```bash
17+
R CMD build .
18+
R CMD check --no-manual --compact-vignettes=gs+qpdf mori_*.tar.gz # matches CI
19+
```
1020

11-
Standard R-package workflow (`devtools::test()`, `devtools::document()`, `R CMD build` / `R CMD check`). Run a single test file with `testthat::test_file("tests/testthat/test-nested.R")`.
21+
- `Config/build/compilation-database: true` in DESCRIPTION makes R generate `compile_commands.json` on install, so clangd C navigation works out of the box (gitignored).
1222

1323
## Storage Model
1424

@@ -165,5 +175,6 @@ testthat edition 3. Entry point `tests/testthat.R`; tests in `tests/testthat/tes
165175

166176
- roxygen2 with markdown support; NAMESPACE is auto-generated.
167177
- MIT license.
178+
- Version is `major.minor.patch.dev` (current dev tag `.9000`).
168179
- `README.md` is generated from `README.Rmd` — edit the `.Rmd` and re-knit, never edit `README.md` directly.
169-
- `CLAUDE.md` and `.claude/` are excluded from package builds (via `.Rbuildignore`).
180+
- `AGENTS.md`, `.claude/`, and `.posit/` are in `.Rbuildignore` and don't ship to CRAN.

0 commit comments

Comments
 (0)