Permalink
Browse files

added docs

  • Loading branch information...
1 parent 2881776 commit 887124c04d1d1813d8791d11b37a1fb5dc041765 @sekimura committed Feb 17, 2009
Showing with 16 additions and 27 deletions.
  1. +16 −27 README.markdown
View
@@ -1,40 +1,29 @@
Text-Markdown-PegMarkdown version 0.01
======================================
-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
-
-A README file is required for CPAN modules since CPAN extracts the
-README file from a module distribution so that people browsing the
-archive can use it get an idea of the modules uses. It is usually a
-good idea to provide version information here so that people can
-decide whether fixes for the module are worth downloading.
+Text::Markdown::PegMarkdow - Perl extension for John MacFarlane's
+peg-markdown, an implementation of markdown in C, using a PEG
+(parsing expression grammar).
INSTALLATION
+============
To install this module type the following:
- perl Makefile.PL
- make
- make test
- make install
-
-DEPENDENCIES
-
-This module requires these other modules and libraries:
+ perl Makefile.PL
+ make
+ make test
+ make install
- blah blah blah
+If you have a trouble with downloading a tarball from github.com
+during "perl Makefile.PL". Try to use "git" instead.
-COPYRIGHT AND LICENCE
+ git clone git://github.com/jgm/peg-markdown.git jgm-peg-markdown
-Put the correct copyright and licence information here.
-
-Copyright (C) 2009 by Masayoshi Sekimura
-
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself, either Perl version 5.10.0 or,
-at your option, any later version of Perl 5 you may have available.
+And then, run "perl Makefile.PL" again.
+DEPENDENCIES
+============
+peg-markdwon requires [glib2](http://www.gtk.org/download.html).
+So Makefile.PL does.

0 comments on commit 887124c

Please sign in to comment.