agentleFS
Sign inStart free
espresso3389espresso3389/pdfrx/AGENTS.md

pdfrx

AGENTS.md284 starsChanged 17 days agoMITView on GitHub

Detailed guidance is split into focused files in doc/agents/: pdfrx is a monorepo containing five packages: See doc/agents/PROJECT-STRUCTURE.md for detailed package descriptions.

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

5 rules. About 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep existing user changes intact.

    line 7
  2. Very specific:

    Prefer fast, non-destructive tools (rg, rg --files, targeted tests) and run commands with an explicit workdir.

    line 8
  3. Very specific:

    Read the relevant doc/agents/ file before changing package structure, commands, style, or release/publishing flow.

    line 9
  4. Very specific:

    Leave release artifacts (CHANGELOG.md, version numbers, tags) untouched unless the task is explicitly about publishing.

    line 10
  5. Distinctive:

    Default to ASCII output and add only brief clarifying comments when the code is non-obvious.

    line 11

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md

This file provides guidance to AI agents and developers when working with code in this repository.

Quick Start for Agents

  • Keep existing user changes intact. If unexpected edits overlap your task and make the next step ambiguous, pause and ask how to proceed; otherwise work around them without reverting.
  • Prefer fast, non-destructive tools (rg, rg --files, targeted tests) and run commands with an explicit workdir; avoid wandering cd commands in agent-run shells.
  • Read the relevant doc/agents/ file before changing package structure, commands, style, or release/publishing flow.
  • Leave release artifacts (CHANGELOG.md, version numbers, tags) untouched unless the task is explicitly about publishing.
  • Default to ASCII output and add only brief clarifying comments when the code is non-obvious.

Documentation Index

Detailed guidance is split into focused files in doc/agents/:

  • doc/agents/PROJECT-STRUCTURE.md - Package overview, dependencies, and architecture
  • doc/agents/COMMANDS.md - Common commands, testing, and platform builds
  • doc/agents/RELEASING.md - Release process and publishing checklist
  • doc/agents/CODE-STYLE.md - Code style, documentation, and dependency policies

Project Overview (Summary)

pdfrx is a monorepo containing five packages:

  1. pdfium_dart - Low-level Dart FFI bindings for PDFium
  2. pdfium_flutter - Flutter FFI plugin for native PDFium packaging
  3. pdfrx_engine - Platform-agnostic PDF rendering API (pure Dart)
  4. pdfrx - Cross-platform PDF viewer Flutter plugin
  5. pdfrx_coregraphics - CoreGraphics-backed renderer for iOS/macOS (experimental)

See doc/agents/PROJECT-STRUCTURE.md for detailed package descriptions.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free