Home > Vocabulary

Vocabulary

Vocabulary is a project mainly written in Ruby, it's free.

Vocabulary helps you to generate Flash cards for your study needs.

                                Vocabulary
                          Version 

WHAT IS THE VOCABULARY PROJECT ?

This program helps you to generate your Flash cards easily. It currently only supports German.

FEATURES

o Application o Commandline arguments interface

o Languages o German

o Feature Providing Base Libraries

o Supported Ressources

o Development

o Development Base Libraries

o Code Quality

ON WHAT HARDWARE DOES IT RUN?

This Software was originally developed and tested on 32-bit x86 / SMP based PCs running on
Ubuntu and Gentoo GNU/Linux 2.6.x. Other direct Linux and Unix derivates should be viable too as
long as all dynamical linking dependencys are met. 

DOCUMENTATION

A general developers API guide can be extracted from the Doxygen
subdirectory which is able to generate HTML as well as PDF docs. Please refer to the
[Rake|Make]file for additional information how to generate this documentation.

INSTALLING

If you got this package as a packed tar.gz or tar.bz2 please unpack the contents in
an appropriate folder e.g. ~/jokemachine/ and follow the supplied INSTALL or README
documentation. Please delete or replace existing versions before unpacking/installing
new ones.

SOFTWARE REQUIREMENTS

This package was developed and compiled under Gentoo GNU/Linux 2.6.x with the Ruby 1.8.x MRI
interpreter. It needs a properly installed LaTeX system.

BUILD PROCESS

CONFIGURING

COMPILING

RUNNING

DEVELOPMENT

% rake -T (in /home/br/projects/Battery) rake all # Default Task - Run cucumber and rspec with rcov rake clean # Clean up temporary data rake cucumber # Run Cucumber features rake flay # Flay the code rake flog # Flog the code rake rcov:all # Run both specs and features to generate aggregated coverage rake rcov:clobber_rspec # Remove rcov products for rspec rake rcov:cucumber # Run Cucumber features rake rcov:rspec # Run specs using RCov rake yardoc # Generate Yardoc documentation

IF SOMETHING GOES WRONG

In case you enconter bugs which seem to be related to the JOKESMACHINE package please check in
the MAINTAINERS file for the associated person in charge and contact him or her directly. If
there is no valid address then try to mail Bjoern Rennhak <bjoern AT rennhak DOT com> to get
some basic assistance in finding the right person in charge of this section of the JOKESMACHINE
project.

NOTES

This README file was last modified on the $LastChangedDate$
by $LastChangedBy$. Current file version is $Rev$ (which is a minor revision number) .

COPYRIGHT

(c) 2011, Bjoern Rennhak, under a triple license

o MIT licence. http://www.opensource.org/licenses/mit-license.php
o GPLv2 license
o BSD license

Please refer to the COPYRIGHT file in the various folders for explicit copyright notice.  Unless
otherwise stated all remains protected and copyrighted by Bjoern Rennhak <bjoern AT rennhak DOT
com>.

vim:ts=2:tw=100:wm=100

Previous:SmileyFeedback