NAME

App::Tarotplane - Curses flashcard program

SYNOPSIS

use App::Tarotplane;

$tarotplane = App::Tarotplane->init();
$tarotplane->run();

DESCRIPTION

App::Tarotplane is the module that does all of the work for tarotplane. If you're looking for tarotplane documentation, you should consult its manual page instead of this one.

Object Methods

App::Tarotplane->init()

Reads @ARGV and returns an initialized App::Tarotplane object. Read the documentation for tarotplane for a list of what options are available to tarotplane.

$tarotplane->run()

Runs tarotplane.

$tarotplane->get($get)

Get member $get from $tarotplane. The following are valid gets:

Files

Array ref of supplied file arguments.

Sort

Sort method used, see %CARD_SORT below.

OrderBy

If ordering cards, what to order by. Can either be 'Term' or 'Definition'.

First

Which card side to display first. Can either be 'Term' or 'Definition'.

get() primarily exists for testing purposes.

Global Variables

$App::Tarotplane::VERSION

tarotplane version.

%CARD_SORT
use App::Tarotplane qw(%CARD_SORT);

Hash map of different ways tarotplane can sort cards.

None

Cards are sorted as they appear in the given files.

Random

Cards are sorted in random order.

Order

Cards are sorted in alphabetical order.

AUTHOR

Written by Samuel Young <samyoung12788@gmail.com>.

COPYRIGHT

Copyright 2024, Samuel Young

This library is free software; you may redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

tarotplane