Skip to content

Commit

Permalink
I guess I do no need two versions of README files
Browse files Browse the repository at this point in the history
  • Loading branch information
gugod committed Apr 15, 2021
1 parent 3faed12 commit 1c38cb8
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 268 deletions.
132 changes: 89 additions & 43 deletions README
Original file line number Diff line number Diff line change
@@ -1,49 +1,88 @@
Name:
NAME

App::perlbrew - Manage perl installations in your $HOME

Description:
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

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.
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.

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

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
Expand All @@ -56,9 +95,9 @@ Installation:

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
Expand All @@ -68,34 +107,41 @@ Installation:
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.
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

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>"
AUTHOR

Kang-min Liu <gugod@gugod.org>

COPYRIGHT

Copyright (c) 2021 Kang-min Liu <gugod@gugod.org>.

LICENCE

The MIT License

Copyright:
Copyright (c) 2021 Kang-min Liu "<gugod@gugod.org>".
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
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
Expand Down
159 changes: 0 additions & 159 deletions README.md

This file was deleted.

Loading

0 comments on commit 1c38cb8

Please sign in to comment.