Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ReadMe.pod #124

Open
wants to merge 1 commit into
base: perlpunk/fix-out-emit-yaml
Choose a base branch
from
Open
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
63 changes: 2 additions & 61 deletions ReadMe.pod
Original file line number Diff line number Diff line change
@@ -1,62 +1,3 @@
=pod
ests easier to groom.

=for comment
DO NOT EDIT. This Pod was generated by Swim v0.1.46.
See http://github.com/ingydotnet/swim-pm#readme

=encoding utf8

=head1 Name

YAML Test Suite - Comprehensive Test Suite for YAML

=head1 Overview

This test suite is composed of (what will eventually be) 100s of test
directories that each represent a specific situation for a YAML processor.
Each test directory contains a number of related files, that test suites can
be made to use in interesting ways. For example:

=over

=item * Metadata about the test

=over

=item * Name (short phrase)

=item * Tags

=item * Description

=back

=item * Input YAML

=item * Canonical Output YAML

=item * Matching JSON

=item * Token stream notation

=item * Event stream notation

=item * Error data

=item * etc

=back

Not every test dir will have the same elements. Since the tests are just data,
it is up to the framework using the tests to decide which tests to use and how
to use them.

The tests are currently written in TestML under the C<test> directory on the
C<master> branch. The test data is split into the separate files structure,
and kept on the C<data> branch. This makes tests easier to groom.

To get a quick overview of the tests you can have a look at the L<YAML Test
Matrix|http://matrix.yaml.io/> -
L<https://github.com/perlpunk/yaml-test-matrix>.

=cut
To