Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 94 lines (62 sloc) 2.622 kb
27fe603 @sorear Add license & credits info
authored
1 =head1 ABOUT
2
4391579 @moritz fix grammar in README.pod
moritz authored
3 This is 'Niecza', which is a Perl 6 implementation focusing on
2c56dcb @sorear Update README and clarify the use of "make" (hakank++)
authored
4 optimization and efficient implementation research. It targets the
5 Common Language Runtime (ECMA-335; implementations are "Mono" and ".NET").
b2ed5f8 @sorear Add a README for GitHub's sake
authored
6
2c56dcb @sorear Update README and clarify the use of "make" (hakank++)
authored
7 For a list of supported features, see L<http://perl6.org/compilers/features>.
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored
8
4539bcd @sorear Update README with new build info
authored
9 =head1 DEPENDENCIES (RUNTIME)
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored
10
11 =over 4
12
13 =item *
14
11bf899 @sorear Revert use of collectable assemblies for eval
authored
15 To run on Mono: 2.6.4 and later are well-tested, though success has been
16 reported with 2.4.x as well. ggoebel on #perl6 reports that 2.6.7 fails
17 with a bus error on OS X 10.4 x86, but 2.6.4 works; 2.6.7 is fine on other
18 platforms.
19
20 2.8.2 or later is recommended for best performance; you should use
21 C<RUN_CLR=mono-sgen> in this case. 2.10 (latest stable) is also tested.
22
23 Debian and derivatives have a modular mono packaging; you should install
24 'mono-complete'. (The other packages exist for the sake of Debian-packaged
25 programs.)
0cbefbb @sorear Remove stale note reference & talk about Debian packages
authored
26
39ac6c4 @diakopter update on-windows runtime/build rqmts
diakopter authored
27 To run on Windows/Mono (2.8.2 and 2.10) and other systems, download the
28 mono installers from C<http://go-mono.org/>
29
4f2a35b @diakopter README.pod: add a section for Cygwin/.NET; amend the CREDITS section …
diakopter authored
30 =item *
31
240d90d @diakopter more README cleanup/clarification
diakopter authored
32 To run on Windows/Microsoft .NET 3.5 (2.0 runtime with 3.5 extensions)
39ac6c4 @diakopter update on-windows runtime/build rqmts
diakopter authored
33 or .NET 4.0, install the .NET runtime from C<http://goo.gl/PMKvB>
4f2a35b @diakopter README.pod: add a section for Cygwin/.NET; amend the CREDITS section …
diakopter authored
34
557c6d8 @sorear Document LF requirement in README
authored
35 NOTE: Niecza does NOT currently support Windows line endings. Source
36 code (including the setting) must be encoded in Unix format, that is,
37 linefeed only.
38
4539bcd @sorear Update README with new build info
authored
39 =back
40
41 =head1 DEPENDENCIES (BUILD FROM SOURCE)
42
43 =over 4
44
45 =item *
46
47 wget (to fetch a bootstrapping binary).
48
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored
49 =item *
50
4539bcd @sorear Update README with new build info
authored
51 GNU make
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored
52
53 =item *
54
4539bcd @sorear Update README with new build info
authored
55 unzip
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored
56
57 =back
58
59 =head1 USING
60
2c56dcb @sorear Update README and clarify the use of "make" (hakank++)
authored
61 $ make # only if using a source copy
289d4db @sorear Update README
authored
62 ... snip build spam ...
4539bcd @sorear Update README with new build info
authored
63 $ mono run/Niecza.exe
64 niecza> say 2 + 2
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored
65 4
4539bcd @sorear Update README with new build info
authored
66 niecza> ^D
67 $ mono run/Niecza.exe -e 'say 2 + 2'
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored
68 4
69 $
27fe603 @sorear Add license & credits info
authored
70
a520fb3 @sorear Add a few recent discoveries to README
authored
71 Notes: The first time the compiler is run, the setting must be compiled,
72 which adds about a minute on most hardware to the runtime. The second
73 run will be much faster. Also, the recompilation checker is not robust
74 to file format changes; it may be necessary to clean temporary files
75 after updates.
76
39ac6c4 @diakopter update on-windows runtime/build rqmts
diakopter authored
77 Building on Windows currently requires the Cygwin environment with Mono's
78 gmcs.exe in your Cygwin shell's $PATH, though in principle .NET's csc.exe
79 could be made to work eventually, if it doesn't already.
80
27fe603 @sorear Add license & credits info
authored
81 =head1 COPYRIGHT AND LICENSE
82
2c56dcb @sorear Update README and clarify the use of "make" (hakank++)
authored
83 Niecza is Copyright 2010-2011 Stefan O'Rear et al. It may be used and
84 distributed under the Artistic License 2.0 (included under LICENSE).
27fe603 @sorear Add license & credits info
authored
85
50d44e4 @sorear Add new types Int, Rat, FatRat, Complex
authored
86 Some files are included from other projects, and have their own copyright
87 notices.
88
27fe603 @sorear Add license & credits info
authored
89 =head1 CREDITS AND PRIOR ART
90
4f2a35b @diakopter README.pod: add a section for Cygwin/.NET; amend the CREDITS section …
diakopter authored
91 This project was originally a spin-off of experiments done for
39ac6c4 @diakopter update on-windows runtime/build rqmts
diakopter authored
92 Matthew "diakopter" Wilson's sprixel project, and was heavily inspired by
4f2a35b @diakopter README.pod: add a section for Cygwin/.NET; amend the CREDITS section …
diakopter authored
93 many of its lower-level details.
Something went wrong with that request. Please try again.