<div class="blog">
<h1 id="NAME">
-Code is not the only thing
+Newbie Friendly Perl Projects
</h1>
<div class="CONTENT">
-<div style="float: right;"><i><br />I did,<br />no one cared,<br />I spoke,<br />no one heard,<br />I wrote,<br />someone read.<br /></i><br /></div><br /><p style="clear: both;">After only several weeks of maintaining SDL perl, Today I have come to <a href="http://www.nntp.perl.org/group/perl.sdl.devel/2009/08/msg1405.html">noticed </a>how important it is to update README's, docs and so on. I will redouble my effort to do <a href="http://github.com/kthakore/SDL_perl/commit/e504c139e12e5592b5694292bb1882ee78b65b28">this</a>. </p><br /><p>However I am not sure where to start updating docs. Has anyone re-documented old modules before? Any advice? If anyone is interested in helping me to sort out documentation please contact me on sdl-devel@perl.org. For people wanting to learn the SDL base there is no better way.<br /></p><div class="blogger-post-footer"><img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/3102167581424744259-2082858297367668517?l=yapgh.blogspot.com' alt='' /></div></div></div>
\ No newline at end of file
+<div style="text-align: right;"><i>A seed needs soft soil and water to grow</i></div><div style="text-align: right;"></div>This is a reply to <a href="http://szabgab.com/blog/2009/09/1251862435.html">szabgab's</a> post on how to get newbies interested in Perl modules. Being a newbie in Perl myself I thought I should take a shot.<br /><br />I was thinking you can make projects more accessible to newbies by having a step by step plan included with where they need to look. For example for docs of SDL_perl:<br /><ol><li>Look at SDL docs [<a href="http://www.libsdl.org/cgi/docwiki.cgi/SDL_API_by_name">link</a>]</li><li>See where SDL_perl is using the same functions [<a href="http://cpansearch.perl.org/src/KTHAKORE/SDL_Perl-v2.2.2.11/src/SDL.xs">link</a>] and the docs to this file [<a href="http://cpansearch.perl.org/src/KTHAKORE/SDL_Perl-v2.2.2.11/lib/SDL.pm">link</a>]</li><li>Use the pod format to add it to the source [<a href="http://perldoc.perl.org/perlpod.html">link to using pod</a>]</li><li>{BONUS} Come up with tutorial or cookbook [<a href="http://search.cpan.org/%7Edrolsky/Moose-0.89/lib/Moose/Cookbook.pod">link to example</a>]</li><li>Submit code to github [<a href="http://github.com/guides/home">link</a>] or email them to me [<a href="mailto:kthakore@cpan.org">link</a>]<br /></li></ol><br />Basically assume nothing is known. I know this may seem demeaning but I am a newbie to Perl and sometimes I hate looking for crust (docs). I call it crust because a crust is useful for me to eat a pizza slice, but it has no flavor .<br /><br /><i>--yapgh </i><div class="blogger-post-footer"><img width='1' height='1' src='https://blogger.googleusercontent.com/tracker/3102167581424744259-581981098917545448?l=yapgh.blogspot.com' alt='' /></div></div></div>
\ No newline at end of file
projects / sdlgit/SDL-Site.git / blobdiff