Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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