Help language development. Donate to The Perl Foundation

Readline cpan:FOOIST last updated on 2020-09-02

perl6-readline/README.md
Readline
=======

##### *Note: This README will soon be updated based on new development priorities*

Readline provides a Perl 6 interface to libreadline.

XXX This will probably be a frontend to Readline::Gnu when that's factored out.
XXX For the moment keep all the code here in the Readline module.

Installation
============

Please make sure that libreadline is installed beforehand, the tests will fail otherwise. If libreadline is installed but the tests still fail, please note that the Perl 6 package searches a given set of directories for libreadline.{so,dynlib}.* files, otherwise it defaults to v7. If your libreadline installation isn't on any of these paths, or requires non-standard setup, please file an issue.

For those of you on Linux Debian and Linux-alike systems, you should be able to get the latest version with this CLI invocation:

```
	sudo apt-get install libreadline7
```
(I'd prefer to use LibraryCheck, but it fails inside the 'is native()' method call.)


On Macs, use Hombrew to install readline. If you installed Rakudo-Star with homebrew after Sept. 1 it should already be there.

If not you can install just Readline

```
    brew install readline
```

or update your rakudo-star install.

```
    brew upgrade rakudo-star
```



* Using zef (a module management tool bundled with Rakudo Star):



```
    zef update && zef install Readline
```


Or alternatively installing it from a checkout of this repo with zef:

```
    zef install .
```



## Usage

See the `examples/` directory in this project.

## Testing

To run tests:

```
    prove -e perl6
```

## Author

Jeffrey Goff, DrForr on #perl6, https://github.com/drforr/
(Recently taken over by Daniel Lathrop (fooist), https://github.com/fooist/

## License

Artistic License 2.0