ported to test::output
[language-befunge.git] / README
blobcd6629857d1f52082d94a0b1ffd30ecce0795696
1 NAME
3     Language::Befunge - a Befunge-98 interpreter.
6 DESCRIPTION
8     Enter the realm of topological languages!
10     This module implements the Funge-98 specifications on a 2D field (also
11     called Befunge). It can also work as a Trefunge implementation (3D).
13     This Befunge-98 interpreters assumes the stack and Funge-Space cells of
14     this implementation are 32 bits signed integers (I hope your os
15     understand those integers). This means that the torus (or Cartesian
16     Lahey-Space topology to be more precise) looks like the following:
18                   32-bit Befunge-98
19                   =================
20                           ^
21                           |-2,147,483,648
22                           |
23                           |         x
24               <-----------+----------->
25       -2,147,483,648      |      2,147,483,647
26                           |
27                          y|2,147,483,647
28                           v
30     This implementation is meant to work on unix-like systems, because this
31     interpreters only handle the character which ordinal value is 10 (also
32     known as \n) as an End-Of-Line chars. In particular, no warranty is made
33     neither for Microsoft systems (\r\n) nor for Macs (\r).
35     This module also implements the Concurrent Funge semantics.
38 INSTALLATION
40     To install this module type the following (you should be familiar
41     with those instructions ;) ):
43        perl Makefile.PL
44        make
45        make test
46        make install
49 DEPENDENCIES
51     I decided to require at least perl v5.6 in order to have a clean
52     programming style (use diagnostics, our, etc.).
54     This module requires Storable in order to be a proper Concurrent
55     Funge (or you can cut in the sources the relevant parts).
58 AUTHOR
60     Jerome Quelin, <jquelin@cpan.org>
62     Development is discussed on <language-befunge@mongueurs.net>
65 COPYRIGHT
67     Copyright (c) 2001-2008 Jerome Quelin, all rights reserved.
69     This program is free software; you can redistribute it and/or modify
70     it under the same terms as Perl itself.