From e12807a617d7239cf32f689c6a802f20bb81aba8 Mon Sep 17 00:00:00 2001 From: "Ahmad M. Zawawi" Date: Mon, 2 Nov 2015 11:43:35 +0200 Subject: [PATCH] More documentation and markup fixes in README --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 662d0f8..7814c0f 100644 --- a/README.md +++ b/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. @@ -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