<commit_before>## $Id$

=head1 NQP - Not Quite Perl (6)

This is "Not Quite Perl" -- a compiler for quickly generating PIR
routines from Perl6-like code.  The key feature of NQP is that it's
designed to be a very small compiler (as compared with, say, perl6)
and is focused on being a high-level way to create transformers
for Parrot (especially hll compilers).  In addition, unlike perl6,
NQP attempts to restrict itself to generating code that can run
in Parrot without the existence of any NQP-specific runtime
libraries.

One way that NQP aims to be a lighter version of Perl 6 is by
avoiding syntactic sugar and "dwimminess" that isn't needed
for the types of routines that are written.  Sometimes this
makes coding a bit more work, but it also lowers the learning
curve somewhat.


=head2 Things that NQP has (or should have)

This list isn't exhaustive; for now it's intended to identify the
language constructs that we explicitly know will be supported

=over 4

=item * scalars

=item * binding

=item * lexical 'my', package 'our'

=item * method calls (including named arguments)

=item * subroutine calls (including named arguments)

=item * method definitions

=item * subroutine definitions

=item * '...'                 # string constants

=item * "..."                 # string value with escapes (non-interpolating)

=item * postcircumfix:<[ ]>   # array subscript

=item * postcircumfix:<{ }>   # hash subscript

=item * postcircumfix:«< >»   # constant hash subscript

=item * $<...>                # constant hash subscript of $/

=item * $(...)                # scalar context

=item * prefix:~              # string context

=item * prefix:+              # numeric context

=item * say(), print()        # output

=item * if/unless             # conditional

=item * for                   # iterative loop

=item * PIR q<>, PIR q:to:<END> # inline PIR

=back

=head2 Things that aren't in NQP

There are a large number of Perl 6 constructs and idioms that
aren't supported or expected to be supported in NQP.  This
is by design -- the point of NQP is to provide a lightweight
HLL for generating PIR subroutines while adhering to a Perl 6
syntax.

Some items not planned for NQP:

=over 4

=item * string interpolation

=item * listops

=item * quoted lists

=item * array and hash slices

=back

Of course, if we later decide that some item is vitally
important for NQP programs, we can add it -- but for now
the point is to maintain a minimal set of constructs.

<commit_msg>[nqp]: readme updates<commit_after>## $Id$

=head1 NQP - Not Quite Perl (6)

This is "Not Quite Perl" -- a compiler for quickly generating PIR
routines from Perl6-like code.  The key feature of NQP is that it's
designed to be a very small compiler (as compared with, say, perl6)
and is focused on being a high-level way to create transformers
for Parrot (especially hll compilers).  In addition, unlike perl6,
NQP attempts to restrict itself to generating code that can run
in Parrot without the existence of any NQP-specific runtime
libraries.

One way that NQP aims to be a lighter version of Perl 6 is by
avoiding syntactic sugar and "dwimminess" that isn't needed
for the types of routines that are written.  Sometimes this
makes coding a bit more work, but it also lowers the learning
curve somewhat.


=head2 Things that NQP has (or should have)

This list isn't exhaustive; for now it's intended to identify the
language constructs that we explicitly know will be supported

=over 4

=item * scalars

=item * binding

=item * lexical 'my', package 'our'

=item * method calls (including named, optional, and slurpy arguments)

=item * subroutine calls (including named, optional, and slurpy arguments)

=item * method definitions

=item * subroutine definitions

=item * '...'                 # string constants

=item * "..."                 # string value with escapes (non-interpolating)

=item * postcircumfix:<[ ]>   # array subscript

=item * postcircumfix:<{ }>   # hash subscript

=item * postcircumfix:«< >»   # constant hash subscript

=item * $<...>                # constant hash subscript of $/

=item * $(...)                # scalar context

=item * prefix:~              # string context

=item * prefix:+              # numeric context

=item * say(), print()        # output

=item * if/unless             # conditional

=item * for                   # iterative loop

=item * PIR q<>, PIR q:to:<END> # inline PIR

=back

=head2 Things that aren't in NQP

There are a large number of Perl 6 constructs and idioms that
aren't supported or expected to be supported in NQP.  This
is by design -- the point of NQP is to provide a lightweight
HLL for generating PIR subroutines while adhering to a Perl 6
syntax.

Some items not planned for NQP:

=over 4

=item * string interpolation

=item * listops

=item * quoted lists

=item * array and hash slices

=back

Of course, if we later decide that some item is vitally
important for NQP programs, we can add it -- but for now
the point is to maintain a minimal set of constructs.


{'fraction_non_alphanumeric': 0.07584158415841584, 'fraction_numerical': 0.004752475247524752, 'mean_word_length': 3.1300081766148815, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3185412', 'n_tokens_mistral': 1539, 'n_tokens_neox': 1414, 'n_words': 714}