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
7 changes: 7 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Please read the [Developers Guide](documentation/DEVELOPMENT.md) and other files
in [documentation/](documentation/).

When you are done, please execute these tasks in the root folder:

- `make build` to type-check the codebase
- `make test` to execute all tests
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
11 changes: 10 additions & 1 deletion documentation/DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Developers Guide

This guide is for all codebases in this mono-repo.
This monorepo contains the code for Text-Runner and its standard library.

## Setup after cloning

Expand All @@ -15,6 +15,15 @@ To get the codebase into a runnable state after cloning:

- <code type="make/command" dir="..">make setup</code> to install dependencies

## Folders

- text-runner-engine: implements the Text-Runner functionality as a library
- text-runner-cli: a CLI wrapper around the Text-Runner engine, to call
Text-Runner in a shell
- text-runner-features: end-to-end tests for Text-Runner

The other folders are Text-Runner plugins or utility folders.

## Running tools

All codebases in this mono-repo provide a standardized set of commands for
Expand Down