Skip to content

Commit

Permalink
More documentation and markup fixes in README
Browse files Browse the repository at this point in the history
  • Loading branch information
azawawi committed Nov 2, 2015
1 parent 1d017f1 commit e12807a
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
@@ -1,7 +1,4 @@
Farabi6
=======

[![Build Status](https://travis-ci.org/azawawi/farabi6.svg?branch=master)](https://travis-ci.org/azawawi/farabi6)
# Farabi6 [![Build Status](https://travis-ci.org/azawawi/farabi6.svg?branch=master)](https://travis-ci.org/azawawi/farabi6)

This is a fun Perl 6 port of the Farabi Modern Perl Editor http://metacpan.org/module/Farabi.
The idea here is to experiment with a Perl 6 in-browser editor running over Rakudo Perl 6.
Expand All @@ -15,25 +12,34 @@ Have fun!

To run it from the local directory:

bin/farabi6
# farabi6 will try to open http://localhost:3030 in your browser
```
$ bin/farabi6
# farabi6 will try to open http://localhost:3030 in your browser
```


To install it using Panda (a module management tool bundled with Rakudo Star):

panda update
panda install Farabi6
farabi6
# farabi6 will try to open http://localhost:3030 in your browser
```
$ panda update
$ panda install Farabi6
$ farabi6
# farabi6 will try to open http://localhost:3030 in your browser
```

You can also change the host name and port using the following command:

farabi6 --host=localhost --port=4040
```
$ farabi6 --host=localhost --port=4040
```

## Testing

To run tests:

prove -e perl6
```
$ prove -e "perl6 -Ilib"
```

## Author

Expand Down

0 comments on commit e12807a

Please sign in to comment.