=head1 Alien::TinyCCx

A Perl Alien module for the Tiny C Compiler with extended symbol table management. This Perl distribution distributes and contains the build steps necessary to ensure that the Tiny C Compiler is available on your system.

=head1 INSTALLATION FROM SOURCES

If you are installing this directly from the sources on github, here are the steps you should take after downloading the tarball:

cpan Module::Build File::ShareDir File::Which git submodule init git submodule update

Then follow the installation instructions in the next section.

=head1 INSTALLATION

I assume that if you are installing this module, you are doing so from CPAN. The usual Module::Build incantation shold work:

perl Build.PL ./Build ./Build test ./Build install

On Windows, you should omit the C<./> part of the C commands.

=head1 DEVELOPMENT

If you want to work on Alien::TCCx itself, you will need to work with a clone of this repository, as well as a clone of the tinycc subrepository. To set everything up, create a F file and run the C command:

perl Build.PL ./Build devsetup

The C command is essentially equivalent to

git submodule init git submodule update cp git-pre-commit-hook.pl .git/hooks/pre-commit

The last bit, the commit hook, helps me keep the Changes file up-to-date. :-)

Also, C and C will restore the contents of F to their original state, and should be used instead of Build command C and C.

=head1 LICENSE, COPYRIGHT

This distribution distributes the source for the Tiny C Compiler project under the src/ directory, for which the following notice is in effect:

• Permission is hereby granted, free of charge, to any person obtaining a copy
• of this software and associated documentation files (the "Software"), to deal
• in the Software without restriction, including without limitation the rights
• to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
• copies of the Software, and to permit persons to whom the Software is
• furnished to do so, subject to the following conditions:
• The above copyright notice and this permission notice shall be included in
• all copies or substantial portions of the software.
• THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
• IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
• FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
• THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
• LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
• OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
• THE SOFTWARE.

The Alien::TCCx Perl module itself is distributed under the same terms as Perl itself.

=cut