view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

View the documentation for `ExtUtils::MakeMaker` for more information on
configuring the build process.

## Usage
**tarotplane** works by reading flash cards from card files given to it as
arguments. Please read the manual for more in-depth documentation on the usage
of **tarotplane**.

### Card Files
A **tarotplane** card file is a text file that contains cards seperated by a
delimitting line, which is a line the contains nothing but a percentage (%)
sign. Each card must contain a term and a definition, seperated by a colon (:).
Terms precede the colon, definitions follow the colon.

Lines starting with a hash (#) are treated as comments and are ignored. Blank
lines are also ignored.

#### Escape Sequences
An escape sequence is a pair of characters, a forward slash (\\) and some other
character, that enables special behavior in **tarotplane** when
reading/displaying cards. Below is a list of all the escape sequences

bin/tarotplane  view on Meta::CPAN

I<file> is the path to the card files to read cards from. Multiple card files
can be given as input. If I<file> is a single dash (C<->), B<tarotplane> will
read from standard input.

=head2 Card Files

A B<tarotplane> card file is a text file that contains cards. Each card must
contain a term and definition, which are seperated by a colon (:). Terms
precede the colon, definitions follow the colon. Cards are
seperated from each other by a delimitting line, which is a line that only
contains a percentage (%) sign. Any whitespace found in the terms and
definitions will be truncated to a single space character. Leading and trailing
whitespace for terms/definitions are trimmed. A detailed example card file can
be found in the EXAMPLES section of this manual.

Empty cards are ignored and will not throw an error. This means if you have a
card file like this:

  %
  Term 1: Definiton 1
  %