Skip to content

Commit

Permalink
Documentation updates (exercism#595)
Browse files Browse the repository at this point in the history
  • Loading branch information
m-dango authored Aug 6, 2023
1 parent 214ce7d commit 7b64a45
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 34 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Exercism Perl 5 Track
# Exercism Perl Track

Exercism exercises in Perl 5
Exercism exercises in Perl

## Dependencies

Expand Down Expand Up @@ -41,7 +41,7 @@ the test will run using the example in the `.meta/solutions` directory.
Please see the [contributing guide] for information from Exercism.
When editing Markdown files in this repository, please use one line ↔ one sentence.

### Perl 5 icon
### Perl icon

The onion is the logo of the [Perl Foundation].
It is trademarked, and we have adapted it--changing the color--with their permission.
Expand Down
30 changes: 14 additions & 16 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
# Installation

## Unix/Linux/Mac OSX
Perl 5 is likely already installed. Run `perl -v` to check which version you have.
If your version is older than v5.14.0, or you would like to try out newer versions
of Perl 5, take a look at 'Other Options'.
Perl is likely already installed. Run `perl -v` to check which version you have.
If your version is older than v5.20, or you would like to try out newer versions of Perl, take a look at 'Other Options'.

If you are using Fedora/Red Hat/CentOS, some core modules are not included with Perl.
Use the `yum install perl-core` command to install them.

## Windows
[Strawberry Perl](http://strawberryperl.com/): A 100% Open Source Perl for
Windows that is exactly the same as Perl everywhere else; this includes using
modules from CPAN, without the need for binary packages.
[Strawberry Perl](http://strawberryperl.com/): A 100% Open Source Perl for Windows that is exactly the same as Perl everywhere else;
this includes using modules from CPAN, without the need for binary packages.

You can either install this directly from the site or use the
[chocolatey package manager](https://chocolatey.org/packages/StrawberryPerl).
You can either install this directly from the site or use the [chocolatey package manager](https://chocolatey.org/packages/StrawberryPerl).

## Other Options
* [perlbrew](https://perlbrew.pl/): A tool to manage multiple perl installations
in your `$HOME` directory. They are completely isolated perl universes.
* [plenv](https://github.com/tokuhirom/plenv): Installs perls under your home
directory and lets you install modules locally, and allows you to switch to
arbitrary perl versions on your shell.
* [asdf](https://asdf-vm.com/):
A tool version manager allowing for installation of multiple languages, including Perl, which is available as a [community plugin](https://github.com/asdf-vm/asdf-plugins).
* [perlbrew](https://perlbrew.pl/):
A tool to manage multiple Perl installations in your `$HOME` directory.
They are completely isolated Perl universes.
* [plenv](https://github.com/tokuhirom/plenv):
Installs Perls under your home directory and lets you install modules locally, and allows you to switch to arbitrary Perl versions on your shell.
* [ActivePerl Community Edition](https://www.activestate.com/activeperl/downloads):
A free, ready-to-install Perl distribution for Windows, Linux and Mac OS X, designed
for community developers or open source projects that are not business- or mission-critical.
A free, ready-to-install Perl distribution for Windows, Linux and Mac OS X, designed for community developers or open source projects that are not business- or mission-critical.

### Installing Necessary Modules
In addition to Perl 5, you will also need to install the `Test2::V0` testing bundle.
In addition to Perl, you will also need to install the `Test2::V0` testing bundle.
Use the following instructions to set this up (or feel free to use your favorite
module installer if you are already familiar with Perl):

Expand Down
3 changes: 2 additions & 1 deletion docs/LEARNING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Learning

Exercism provides exercises and feedback but can be difficult to jump into for those learning Perl for the first time. Check out [learn.perl.org](http://learn.perl.org/) for instructions and information on getting started with Perl 5.
Exercism provides exercises and feedback but can be difficult to jump into for those learning Perl for the first time.
Check out [learn.perl.org](http://learn.perl.org/) for instructions and information on getting started with Perl.
4 changes: 2 additions & 2 deletions docs/RESOURCES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Modules

Perl 5 comes equipped with a set of core modules which you can find
Perl comes equipped with a set of core modules which you can find
listed on [perldoc](https://perldoc.pl/modules). Typically you will be
able to use any of these modules immediately. (Some distributions may
require you to install core modules separately).

[Awesome Perl](https://github.com/hachiojipm/awesome-perl) is a curated list of
useful modules, and also refers to a selection of other lists of recommendations.

There are several module installers available for Perl 5, which will allow
There are several module installers available for Perl, which will allow
you to install a wide variety of modules available on [CPAN](https://metacpan.org/).

### App::cpm
Expand Down
2 changes: 1 addition & 1 deletion docs/TESTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Run All Tests

There is a Perl 5 script with the extension `.t`, which will be used to test
There is a Perl script with the extension `.t`, which will be used to test
your solution. You can run through the tests by using the command:

`prove .`
Expand Down
16 changes: 8 additions & 8 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@
"uuid": "7fb525b6-67f1-42f6-b4a2-dd53ab2b1f96",
"slug": "installation",
"path": "docs/INSTALLATION.md",
"title": "Installing Perl 5 locally",
"blurb": "Learn how to install Perl 5 locally to solve Exercism's exercises on your own machine"
"title": "Installing Perl locally",
"blurb": "Learn how to install Perl locally to solve Exercism's exercises on your own machine"
},
{
"uuid": "eb56a83d-4802-477e-a1b8-825ac7b452a1",
"slug": "learning",
"path": "docs/LEARNING.md",
"title": "How to learn Perl 5",
"blurb": "An overview of how to get started from scratch with Perl 5"
"title": "How to learn Perl",
"blurb": "An overview of how to get started from scratch with Perl"
},
{
"uuid": "e6d642c6-3af4-4087-a40c-78f5d33f0be8",
"slug": "tests",
"path": "docs/TESTS.md",
"title": "Testing on the Perl 5 track",
"blurb": "Learn how to test your Perl 5 exercises on Exercism"
"title": "Testing on the Perl track",
"blurb": "Learn how to test your Perl exercises on Exercism"
},
{
"uuid": "63163ef6-f778-4694-8b31-7d8c51d5f343",
"slug": "resources",
"path": "docs/RESOURCES.md",
"title": "Useful Perl 5 resources",
"blurb": "A collection of useful resources to help you master Perl 5"
"title": "Useful Perl resources",
"blurb": "A collection of useful resources to help you master Perl"
}
]
}
10 changes: 7 additions & 3 deletions reference/implementing-a-concept-exercise.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# How to implement an Perl 5 concept exercise
# How to implement a Perl concept exercise

TODO: describe how to implement a concept exercise for the Perl 5 track. For inspiration, check out the [C# version of this file][csharp-implementing].
* Create a concept in the config.json concepts array e.g. Arrays, Hashes.
* Create an exercise associated with that concept. See [stories][stories] for ideas.
* Create a test file in the `t` directory, a stub in the `lib` directory, and an example solution in the `.meta` directory.

[csharp-implementing]: https://github.com/exercism/v3/blob/main/csharp/reference/implementing-a-concept-exercise.md
Read more about concept exercises on Exercism's track building documentation: https://exercism.org/docs/building/tracks/concept-exercises

[stories]: https://github.com/exercism/docs/tree/main/building/tracks/stories

0 comments on commit 7b64a45

Please sign in to comment.