We have received the following grant application "RPerl User Documentation". Please leave feedback in the comments field by September 27th, 2015. If your comment does not appear in 24 hours, contact me at tpf-grants-secretary at perl-foundation.org. As we have four proposals on RPerl this time, please use this entry if your comment is about RPerl in general and not specific to each RPerl proposal.
RPerl User Documentation
RPerl v1.1 has been released with a working N-body benchmark, as promised. Thanks to RPerl, we are now able to run N-body at the speed of C++, which was claimed by many in the Perl community to be impossible. This grant proposal is to create an RPerl user tutorial.
Benefits to the Perl Community
The number one request and obvious need at this time is quality RPerl user documentation, to help new RPerl users learn how to write fast software. I am bombarded with a constant, daily stream of requests for this to be done.
Deliverables for this grant proposal are:
- A description of the RPerl grammar and what constitutes valid RPerl syntax
- Documented RPerl solutions to problems in chapters 1 - 6 of Learning Perl
- Web-based presentation of deliverables 1 and 2 on the rperl.org website
I've already written basic POD for command-line usage of RPerl: https://metacpan.org/pod/distribution/RPerl/script/rperl
I've already written some of the code for the solutions to Learning Perl: https://github.com/wbraswell/rperl/tree/master/lib/RPerl/Learning
Exercises in Learning Perl which are not supported by RPerl will be omitted.
I've already got a place-holder section of the website ready for docs: http://rperl.org/use_rperl.html
I've already got the RPerl v1.1 grammar done and working, it just needs docs: https://github.com/wbraswell/rperl/blob/master/lib/RPerl/Grammar.eyp
1a. Describe Eyapp EBNF grammar format and Grammar.eyp file sections
1b. Describe lexical token types
1c. Describe operator precedence and associativity
1d. Describe all grammar rules and productions
1e. Provide examples of valid code
2a. Complete source code of solutions to chapters 1 - 6
2b. Describe how to arrive at each solution
3a. Create POD versions of deliverables 1 and 2
3b. Use POD::Tree::HTML or similar to generate HTML
3c. Integrate HTML into rperl.org web framework
I will begin work immediately upon granting.
I expect work to take approximately 30 to 60 days.
I will release a new version of RPerl to CPAN with the new documentation.
I will release a new version of the RPerl website with the new documentation.
I am the creator and lead developer of RPerl.
I've spent the last 32 months working on RPerl without the support of TPF.
I would like that to change now.