adjust those weird section headings

gugod · Apr 15, 2021 · 3faed12 · 3faed12
1 parent d1f3836
commit 3faed12
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 125 deletions.
diff --git a/README b/README
@@ -1,88 +1,49 @@
-NAME
-
+Name:
     App::perlbrew - Manage perl installations in your $HOME
 
- SYNOPSIS
-
-        # Installation
-        curl -L https://install.perlbrew.pl | bash
-
-        # Initialize
-        perlbrew init
-
-        # See what is available
-        perlbrew available
-
-        # Install some Perls
-        perlbrew install 5.32.1
-        perlbrew install perl-5.28.3
-        perlbrew install perl-5.33.6
-
-        # See what were installed
-        perlbrew list
-
-        # Swith to an installation and set it as default
-        perlbrew switch perl-5.32.1
-
-        # Temporarily use another version only in current shell.
-        perlbrew use perl-5.28.3
-        perl -v
-
-        # Turn it off and go back to the system perl.
-        perlbrew off
-
-        # Turn it back on with 'switch', or 'use'
-        perlbrew switch perl-5.32.1
-        perlbrew use perl-5.32.1
-
-        # Exec something with all perlbrew-ed perls
-        perlbrew exec -- perl -E 'say $]'
-
- DESCRIPTION
-
+Description:
     perlbrew is a program to automate the building and installation of perl
     in an easy way. It provides multiple isolated perl environments, and a
     mechanism for you to switch between them.
 
-    Everything are installed unter ~/perl5/perlbrew. You then need to
+    Everything are installed unter "~/perl5/perlbrew". You then need to
     include a bashrc/cshrc provided by perlbrew to tweak the PATH for you.
-    You then can benefit from not having to run sudo commands to install
-    cpan modules because those are installed inside your HOME too.
-
-    For the documentation of perlbrew usage see perlbrew command on
-    MetaCPAN <https://metacpan.org/>, or by running perlbrew help, or by
-    visiting perlbrew's official website <https://perlbrew.pl/>. The
-    following documentation features the API of App::perlbrew module, and
-    may not be remotely close to what your want to read.
+    You then can benefit from not having to run "sudo" commands to install
+    cpan modules because those are installed inside your "HOME" too.
 
- INSTALLATION
+    For the documentation of perlbrew usage see perlbrew command on MetaCPAN
+    <https://metacpan.org/>, or by running "perlbrew help", or by visiting
+    perlbrew's official website <https://perlbrew.pl/>. The following
+    documentation features the API of "App::perlbrew" module, and may not be
+    remotely close to what your want to read.
 
+Installation:
     It is the simplest to use the perlbrew installer, just paste this
     statement to your terminal:
 
         curl -L https://install.perlbrew.pl | bash
 
-    Or this one, if you have fetch (default on FreeBSD):
+    Or this one, if you have "fetch" (default on FreeBSD):
 
         fetch -o- https://install.perlbrew.pl | sh
 
-    After that, perlbrew installs itself to ~/perl5/perlbrew/bin, and you
-    should follow the instruction on screen to modify your shell rc file to
-    put it in your PATH.
+    After that, "perlbrew" installs itself to "~/perl5/perlbrew/bin", and
+    you should follow the instruction on screen to modify your shell rc file
+    to put it in your PATH.
 
     The installed perlbrew command is a standalone executable that can be
     run with system perl. The minimum required version of system perl is
     5.8.0, which should be good enough for most of the OSes these days.
 
     A fat-packed version of patchperl is also installed to
-    ~/perl5/perlbrew/bin, which is required to build old perls.
+    "~/perl5/perlbrew/bin", which is required to build old perls.
 
-    The directory ~/perl5/perlbrew will contain all install perl
+    The directory "~/perl5/perlbrew" will contain all install perl
     executables, libraries, documentations, lib, site_libs. In the
-    documentation, that directory is referred as perlbrew root. If you need
-    to set it to somewhere else because, say, your HOME has limited quota,
-    you can do that by setting PERLBREW_ROOT environment variable before
-    running the installer:
+    documentation, that directory is referred as "perlbrew root". If you
+    need to set it to somewhere else because, say, your "HOME" has limited
+    quota, you can do that by setting "PERLBREW_ROOT" environment variable
+    before running the installer:
 
         export PERLBREW_ROOT=/opt/perl5
         curl -L https://install.perlbrew.pl | bash
@@ -95,9 +56,9 @@ NAME
 
         cpan App::perlbrew
 
-    In this case, the perlbrew command is installed as /usr/bin/perlbrew or
-    /usr/local/bin/perlbrew or others, depending on the location of your
-    system perl installation.
+    In this case, the perlbrew command is installed as "/usr/bin/perlbrew"
+    or "/usr/local/bin/perlbrew" or others, depending on the location of
+    your system perl installation.
 
     Please make sure not to run this with one of the perls brewed with
     perlbrew. It's the best to turn perlbrew off before you run that, if
@@ -107,41 +68,34 @@ NAME
         cpan App::perlbrew
 
     You should always use system cpan (like /usr/bin/cpan) to install
-    App::perlbrew because it will be installed under a system PATH like
-    /usr/bin, which is not affected by perlbrew switch or use command.
+    "App::perlbrew" because it will be installed under a system PATH like
+    "/usr/bin", which is not affected by perlbrew "switch" or "use" command.
 
-    The self-upgrade command will not upgrade the perlbrew installed by
-    cpan command, but it is also easy to upgrade perlbrew by running cpan
-    App::perlbrew again.
-
- PROJECT DEVELOPMENT
+    The "self-upgrade" command will not upgrade the perlbrew installed by
+    cpan command, but it is also easy to upgrade perlbrew by running "cpan
+    App::perlbrew" again.
 
+Project Development:
     perlbrew project <https://perlbrew.pl/> uses github
-    https://github.com/gugod/App-perlbrew/issues for issue tracking. Issues
-    sent to these two systems will eventually be reviewed and handled.
+    <https://github.com/gugod/App-perlbrew/issues> for issue tracking.
+    Issues sent to these two systems will eventually be reviewed and
+    handled.
 
-    See https://github.com/gugod/App-perlbrew/contributors for a list of
+    See <https://github.com/gugod/App-perlbrew/contributors> for a list of
     project contributors.
 
-AUTHOR
-
-    Kang-min Liu <gugod@gugod.org>
-
-COPYRIGHT
-
-    Copyright (c) 2021 Kang-min Liu <gugod@gugod.org>.
-
-  LICENCE
-
-    The MIT License
+Author:
+    Kang-min Liu "<gugod@gugod.org>"
 
- DISCLAIMER OF WARRANTY
+Copyright:
+    Copyright (c) 2021 Kang-min Liu "<gugod@gugod.org>".
 
+Disclaimer of Warranty:
     BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-    FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
-    WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
-    PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
-    EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+    PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
+    EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
     ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
     YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 App::perlbrew - Manage perl installations in your `$HOME`
 
-## SYNOPSIS
+# SYNOPSIS
 
     # Installation
     curl -L https://install.perlbrew.pl | bash
@@ -14,31 +14,31 @@ App::perlbrew - Manage perl installations in your `$HOME`
     perlbrew available
 
     # Install some Perls
-    perlbrew install 5.18.2
-    perlbrew install perl-5.8.1
-    perlbrew install perl-5.19.9
+    perlbrew install 5.32.1
+    perlbrew install perl-5.28.3
+    perlbrew install perl-5.33.6
 
     # See what were installed
     perlbrew list
 
     # Swith to an installation and set it as default
-    perlbrew switch perl-5.18.2
+    perlbrew switch perl-5.32.1
 
     # Temporarily use another version only in current shell.
-    perlbrew use perl-5.8.1
+    perlbrew use perl-5.28.3
     perl -v
 
-    # Or turn it off completely. Useful when you messed up too deep.
-    # Or want to go back to the system Perl.
+    # Turn it off and go back to the system perl.
     perlbrew off
 
-    # Use 'switch' command to turn it back on.
-    perlbrew switch perl-5.12.2
+    # Turn it back on with 'switch', or 'use'
+    perlbrew switch perl-5.32.1
+    perlbrew use perl-5.32.1
 
     # Exec something with all perlbrew-ed perls
     perlbrew exec -- perl -E 'say $]'
 
-## DESCRIPTION
+# DESCRIPTION
 
 [perlbrew](https://metacpan.org/pod/perlbrew) is a program to automate the building and installation of perl in an
 easy way. It provides multiple isolated perl environments, and a mechanism
@@ -55,7 +55,7 @@ or by visiting [perlbrew's official website](https://perlbrew.pl/). The followin
 features the API of `App::perlbrew` module, and may not be remotely
 close to what your want to read.
 
-## INSTALLATION
+# INSTALLATION
 
 It is the simplest to use the perlbrew installer, just paste this statement to
 your terminal:
@@ -71,7 +71,7 @@ should follow the instruction on screen to modify your shell rc file to put it
 in your PATH.
 
 The installed perlbrew command is a standalone executable that can be run with
-system perl. The minimum system perl version requirement is 5.8.0, which should
+system perl. The minimum required version of system perl is 5.8.0, which should
 be good enough for most of the OSes these days.
 
 A fat-packed version of [patchperl](https://metacpan.org/pod/patchperl) is also installed to
@@ -113,22 +113,10 @@ The `self-upgrade` command will not upgrade the perlbrew installed by cpan
 command, but it is also easy to upgrade perlbrew by running `cpan App::perlbrew`
 again.
 
-## METHODS
-
-- (Str) current\_perl
-
-    Return the "current perl" object attribute string, or, if absent, the value of
-    `PERLBREW_PERL` environment variable.
-
-- (Str) current\_perl (Str)
-
-    Set the `current_perl` object attribute to the given value.
-
-## PROJECT DEVELOPMENT
+# PROJECT DEVELOPMENT
 
 [perlbrew project](https://perlbrew.pl/) uses github
-[https://github.com/gugod/App-perlbrew/issues](https://github.com/gugod/App-perlbrew/issues) and RT
-<https://rt.cpan.org/Dist/Display.html?Queue=App-perlbrew> for issue
+[https://github.com/gugod/App-perlbrew/issues](https://github.com/gugod/App-perlbrew/issues) for issue
 tracking. Issues sent to these two systems will eventually be reviewed
 and handled.
 
@@ -141,13 +129,13 @@ Kang-min Liu  `<gugod@gugod.org>`
 
 # COPYRIGHT
 
-Copyright (c) 2010- Kang-min Liu `<gugod@gugod.org>`.
+Copyright (c) 2021 Kang-min Liu `<gugod@gugod.org>`.
 
-### LICENCE
+# LICENCE
 
 The MIT License
 
-## DISCLAIMER OF WARRANTY
+# DISCLAIMER OF WARRANTY
 
 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN

diff --git a/lib/App/perlbrew.pm b/lib/App/perlbrew.pm
@@ -3401,7 +3401,7 @@ __END__
 
 App::perlbrew - Manage perl installations in your C<$HOME>
 
-=head2 SYNOPSIS
+=head1 SYNOPSIS
 
     # Installation
     curl -L https://install.perlbrew.pl | bash
@@ -3437,7 +3437,7 @@ App::perlbrew - Manage perl installations in your C<$HOME>
     # Exec something with all perlbrew-ed perls
     perlbrew exec -- perl -E 'say $]'
 
-=head2 DESCRIPTION
+=head1 DESCRIPTION
 
 L<perlbrew> is a program to automate the building and installation of perl in an
 easy way. It provides multiple isolated perl environments, and a mechanism
@@ -3454,7 +3454,7 @@ or by visiting L<perlbrew's official website|https://perlbrew.pl/>. The followin
 features the API of C<App::perlbrew> module, and may not be remotely
 close to what your want to read.
 
-=head2 INSTALLATION
+=head1 INSTALLATION
 
 It is the simplest to use the perlbrew installer, just paste this statement to
 your terminal:
@@ -3512,7 +3512,7 @@ The C<self-upgrade> command will not upgrade the perlbrew installed by cpan
 command, but it is also easy to upgrade perlbrew by running C<cpan App::perlbrew>
 again.
 
-=head2 PROJECT DEVELOPMENT
+=head1 PROJECT DEVELOPMENT
 
 L<perlbrew project|https://perlbrew.pl/> uses github
 L<https://github.com/gugod/App-perlbrew/issues> for issue
@@ -3530,11 +3530,11 @@ Kang-min Liu  C<< <gugod@gugod.org> >>
 
 Copyright (c) 2021 Kang-min Liu C<< <gugod@gugod.org> >>.
 
-=head3 LICENCE
+=head1 LICENCE
 
 The MIT License
 
-=head2 DISCLAIMER OF WARRANTY
+=head1 DISCLAIMER OF WARRANTY
 
 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN