Skip to content
Newer
Older
100644 108 lines (69 sloc) 2.75 KB
27fe603 @sorear Add license & credits info
authored Jul 4, 2010
1 =head1 ABOUT
2
4391579 @moritz fix grammar in README.pod
moritz authored Nov 4, 2011
3 This is 'Niecza', which is a Perl 6 implementation focusing on
2c56dcb @sorear Update README and clarify the use of "make" (hakank++)
authored Jul 28, 2011
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 Jun 30, 2010
6
2c56dcb @sorear Update README and clarify the use of "make" (hakank++)
authored Jul 29, 2011
7 For a list of supported features, see L<http://perl6.org/compilers/features>.
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored Jul 13, 2010
8
4539bcd @sorear Update README with new build info
authored Jan 14, 2011
9 =head1 DEPENDENCIES (RUNTIME)
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored Jul 14, 2010
10
11 =over 4
12
13 =item *
14
11bf899 @sorear Revert use of collectable assemblies for eval
authored Feb 28, 2011
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 Nov 30, 2010
26
39ac6c4 @diakopter update on-windows runtime/build rqmts
diakopter authored Feb 18, 2011
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 Jan 14, 2011
30 =item *
31
240d90d @diakopter more README cleanup/clarification
diakopter authored Jan 14, 2011
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 Feb 19, 2011
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 Jan 15, 2011
34
557c6d8 @sorear Document LF requirement in README
authored Nov 28, 2011
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 Jan 14, 2011
39 =back
40
41 =head1 DEPENDENCIES (BUILD FROM SOURCE)
42
5b6457f @sorear Document that build-depended tools need to be in PATH to be found (fi…
authored Apr 15, 2012
43 All of these need to be available in PATH.
44
4539bcd @sorear Update README with new build info
authored Jan 14, 2011
45 =over 4
46
47 =item *
48
5b6457f @sorear Document that build-depended tools need to be in PATH to be found (fi…
authored Apr 15, 2012
49 Standard Unix utilities (touch, mkdir, rm, cp, echo)
50
51 =item *
52
4539bcd @sorear Update README with new build info
authored Jan 14, 2011
53 wget (to fetch a bootstrapping binary).
54
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored Jul 14, 2010
55 =item *
56
5b6457f @sorear Document that build-depended tools need to be in PATH to be found (fi…
authored Apr 15, 2012
57 perl (only needed for testing and the Perl 5 interop layer)
58
59 =item *
60
4539bcd @sorear Update README with new build info
authored Jan 14, 2011
61 GNU make
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored Jul 14, 2010
62
63 =item *
64
4539bcd @sorear Update README with new build info
authored Jan 14, 2011
65 unzip
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored Jul 14, 2010
66
5b6457f @sorear Document that build-depended tools need to be in PATH to be found (fi…
authored Apr 15, 2012
67 =item *
68
69 git
70
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored Jul 14, 2010
71 =back
72
73 =head1 USING
74
2c56dcb @sorear Update README and clarify the use of "make" (hakank++)
authored Jul 29, 2011
75 $ make # only if using a source copy
289d4db @sorear Update README
authored Aug 4, 2010
76 ... snip build spam ...
4539bcd @sorear Update README with new build info
authored Jan 14, 2011
77 $ mono run/Niecza.exe
78 niecza> say 2 + 2
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored Jul 14, 2010
79 4
4539bcd @sorear Update README with new build info
authored Jan 14, 2011
80 niecza> ^D
81 $ mono run/Niecza.exe -e 'say 2 + 2'
3b9d4f5 Add automatic STD submodule logic
Stefan O'Rear authored Jul 14, 2010
82 4
83 $
27fe603 @sorear Add license & credits info
authored Jul 4, 2010
84
a520fb3 @sorear Add a few recent discoveries to README
authored Jan 26, 2011
85 Notes: The first time the compiler is run, the setting must be compiled,
86 which adds about a minute on most hardware to the runtime. The second
87 run will be much faster. Also, the recompilation checker is not robust
88 to file format changes; it may be necessary to clean temporary files
89 after updates.
90
39ac6c4 @diakopter update on-windows runtime/build rqmts
diakopter authored Feb 19, 2011
91 Building on Windows currently requires the Cygwin environment with Mono's
92 gmcs.exe in your Cygwin shell's $PATH, though in principle .NET's csc.exe
93 could be made to work eventually, if it doesn't already.
94
27fe603 @sorear Add license & credits info
authored Jul 4, 2010
95 =head1 COPYRIGHT AND LICENSE
96
2c56dcb @sorear Update README and clarify the use of "make" (hakank++)
authored Jul 29, 2011
97 Niecza is Copyright 2010-2011 Stefan O'Rear et al. It may be used and
98 distributed under the Artistic License 2.0 (included under LICENSE).
27fe603 @sorear Add license & credits info
authored Jul 4, 2010
99
50d44e4 @sorear Add new types Int, Rat, FatRat, Complex
authored May 20, 2011
100 Some files are included from other projects, and have their own copyright
101 notices.
102
27fe603 @sorear Add license & credits info
authored Jul 4, 2010
103 =head1 CREDITS AND PRIOR ART
104
4f2a35b @diakopter README.pod: add a section for Cygwin/.NET; amend the CREDITS section …
diakopter authored Jan 15, 2011
105 This project was originally a spin-off of experiments done for
39ac6c4 @diakopter update on-windows runtime/build rqmts
diakopter authored Feb 19, 2011
106 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 Jan 15, 2011
107 many of its lower-level details.
Something went wrong with that request. Please try again.