Permalink
Browse files

Fleshed out README.md to look better on github

  • Loading branch information...
1 parent 735913d commit af2487c0d5bc26b35f7008ebfb9ce3f16faddcc0 Noah Petherbridge committed Apr 20, 2012
Showing with 37 additions and 20 deletions.
  1. +37 −20 README.md
View
@@ -1,21 +1,31 @@
-RiveScript version 1.22
-=======================
+RiveScript-Perl
+===============
+
+INTRODUCTION
+------------
+
+This is the original RiveScript interpreter, written in Perl.
+RiveScript is a scripting language for chatterbots, making it
+easy to write trigger/response pairs for building up a bot's
+intelligence.
INSTALLATION
+------------
To install this module type the following:
- perl Makefile.PL
- make
- make test
- make install
+ perl Makefile.PL
+ make
+ make test
+ make install
RPM BUILD
+---------
To build a RedHat package file for installing RiveScript, use the
rpmbuild Perl script provided in the subversion repository.
-Usage: perl rpmbuild
+ Usage: perl rpmbuild
This results in a slightly different RPM than what you'd get via
cpan2rpm or cpan2dist... along with installing the module in its
@@ -24,29 +34,36 @@ and `rsup` utilities from the bin/ folder into your /usr/bin
directory.
DEPENDENCIES
+------------
Nothing that isn't standard.
COPYRIGHT AND LICENSE
+---------------------
The Perl RiveScript interpreter is dual licensed as of version 1.22. For open
source applications the module is using the GNU General Public License. If
you'd like to use the RiveScript module in a closed source or commercial
application, contact the author for more information.
- RiveScript - Rendering Intelligence Very Easily
- Copyright (C) 2011 Noah Petherbridge
+ RiveScript - Rendering Intelligence Very Easily
+ Copyright (C) 2011 Noah Petherbridge
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
+SEE ALSO
+--------
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+The official RiveScript website, http://www.rivescript.com/

0 comments on commit af2487c

Please sign in to comment.