Skip to content

Commit

Permalink
fix docs, rebuild
Browse files Browse the repository at this point in the history
  • Loading branch information
tbrowder committed Jan 25, 2024
1 parent 24621b4 commit 1ee6dc3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ NAME

**Mi6::Helper** - An aid for converting Raku modules to use **App::Mi6**

WARNING There is a serious bug in the current version: it is unable to to correctly handle a desired module name with mixed '::' and hyphens ('-'). An issue has been filed, but, unless a user needs it soon, a fix will be delayed. A work-around is to manually make the necessary changes after the failure message. Please comment in the issue entry (#11) if a fix is important for your current project.
================================================================================================================================================================================================================================================================================================================================================================================================================

SYNOPSIS
========

use Mi6::Helper
$ mi6-helper new=Foo::Bar # uses the 'provides' text in hidden file
# '.Foo-Bar' (recommended method)

**WARNING** There is a serious bug in the current version: it is unable to to correctly handle a desired module name with mixed '::' and hyphens ('-'). An issue has been filed, but, unless a user needs it soon, a fix will be delayed. A work-around is to manually make the necessary changes after the failure message. Please comment in the issue entry (#11) if a fix is important for your current project.
====================================================================================================================================================================================================================================================================================================================================================================================================================

in the desired **Easily** create the template for a new Raku module repository for management by `App::Mi6` with modifications including:
**Easily** create the template for a new Raku module repository for management by `App::Mi6` with modifications including:

* Published in the **Zef** Raku module ecosystem

Expand Down
16 changes: 7 additions & 9 deletions docs/README.rakudoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@

B<Mi6::Helper> - An aid for converting Raku modules to use B<App::Mi6>

=head1 WARNING There is a serious bug in the current version: it is
unable to to correctly handle a desired module name with
mixed '::' and hyphens ('-'). An issue has been filed, but, unless a
user needs it soon, a fix will be delayed. A work-around is to manually
make the necessary changes after the failure message. Please comment
in the issue entry (#11) if a fix is important for your current project.

=head1 SYNOPSIS

=begin code
Expand All @@ -12,15 +19,6 @@ $ mi6-helper new=Foo::Bar # uses the 'provides' text in hidden file
# '.Foo-Bar' (recommended method)
=end code

=head1 B<WARNING> There is a serious bug in the current version: it is
unable to to correctly handle a desired module name with
mixed '::' and hyphens ('-'). An issue has been filed, but, unless a
user needs it soon, a fix will be delayed. A work-around is to manually
make the necessary changes after the failure message. Please comment
in the issue entry (#11) if a fix is important for your current project.


in the desired
B<Easily> create the template for a new Raku module repository for
management by C<App::Mi6> with modifications including:

Expand Down

0 comments on commit 1ee6dc3

Please sign in to comment.