507
507
tests (for now), you might have a look at how other modules use
508
508
C < Test > . It's quite similar to Perl 5's C < Test::More > .
509
509
510
- = item To document your modules, use L < Perl 6 Pod |
510
+ = begin item
511
+ To document your modules, use L < Perl 6 Pod |
511
512
https://design.perl6.org/S26.html > markup inside your modules. Module
512
513
documentation is most appreciated and will be especially important once
513
514
the Perl 6 module directory (or some other site) begins rendering Pod docs
@@ -521,15 +522,16 @@ lib
521
522
`-- TotalPerspective.pod6
522
523
= end code
523
524
524
- N «
525
- Note, described above is a minimal project directory. If your project
526
- contains scripts that you'd like distributed along with your module(s),
527
- put them in a C < bin > directory. If you'd like a graphical logo to
528
- appear next to your module at the module directory, create a
529
- C < logotype > directory and put into it a C < logo_32x32.png > file. At some
530
- point, you might also consider adding C < CONTRIBUTORS > , C < NEWS > ,
531
- C < TODO > , or other files.
532
- »
525
+ = end item
526
+
527
+ =item
528
+ Note, described above is a minimal project directory. If your project
529
+ contains scripts that you'd like distributed along with your module(s),
530
+ put them in a C < bin > directory. If you'd like a graphical logo to
531
+ appear next to your module at the module directory, create a
532
+ C < logotype > directory and put into it a C < logo_32x32.png > file. At some
533
+ point, you might also consider adding C < CONTRIBUTORS > , C < NEWS > ,
534
+ C < TODO > , or other files.
533
535
534
536
= begin item
535
537
Make your X < C < META6.json > |META6.json> file look something like this:
589
591
To test your module you can use the following command to install the
590
592
module directly from the module folder you just created.
591
593
592
- = for code :lang<shell>
594
+ = begin code :lang<shell>
593
595
zef install ./your-module-folder
596
+ = end code
594
597
595
598
= end item
596
599
@@ -610,8 +613,9 @@ account. The process takes about 5 minutes and some e-mail back and forth.
610
613
611
614
If you use git you can also use the following command to create a package directly for a given commit.
612
615
613
- = for code :lang<shell>
616
+ = begin code :lang<shell>
614
617
git archive --prefix=Vortex-TotalPerspective-0.0.1/ -o ../Vortex-TotalPerspective-0.0.1.tar.gz HEAD
618
+ = end code
615
619
616
620
= end item
617
621
@@ -623,20 +627,16 @@ account. The process takes about 5 minutes and some e-mail back and forth.
623
627
= begin item
624
628
Select your file and click I < Upload > !
625
629
626
- N «
627
- Make sure you have a META6.json file in your dist and that the dist
628
- version you're uploading is higher than the currently uploaded version.
629
- Those are the most common upload errors.
630
- »
630
+ I < Make sure you have a META6.json file in your dist and that the dist
631
+ version you're uploading is higher than the currently uploaded version.
632
+ Those are the most common upload errors. >
631
633
632
634
= end item
633
635
634
636
= head2 Upload your Module to p6c
635
637
636
- N «
637
- The I < p6c > ecosystem is soon to be deprecated, so you should consider
638
- using the I < CPAN > ecosystem instead.
639
- »
638
+ I < The p6c ecosystem is soon to be deprecated, so you should consider
639
+ using the CPAN ecosystem instead. >
640
640
641
641
If you want to use the I < p6c > ecosystem you need to use git for your module's
642
642
version control. The instructions herein assume that you have a
@@ -672,8 +672,9 @@ B<That's it! Thanks for contributing to the Perl 6 community!>
672
672
If you'd like to try out installing your module, use the X < zef > module
673
673
installer tool which is included with Rakudo Star Perl 6:
674
674
675
- = for code :lang<shell>
676
- $ zef install Vortex::TotalPerspective
675
+ = begin code :lang<shell>
676
+ zef install Vortex::TotalPerspective
677
+ = end code
677
678
678
679
This will download your module to its own working directory (C < ~/.zef > ),
679
680
build it there, and install the module into your local Perl 6 installation directory.
0 commit comments