Add README
authorMarius Gavrilescu <marius@ieval.ro>
Mon, 31 Mar 2014 22:52:40 +0000 (01:52 +0300)
committerMarius Gavrilescu <marius@ieval.ro>
Mon, 31 Mar 2014 22:52:40 +0000 (01:52 +0300)
README

diff --git a/README b/README
index ad6f4caec08e629a390cdbeb9e63b80c2f615603..5eaac69b525c512805d6151e1c1a166da62cc95b 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,7 @@
 Text-Homestuck version 0.000_001
 ================================
 
-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::Homestuck is a module that implements the typing quirks of the trolls in Andrew Hussie's webcomic, Homestuck.
 
 INSTALLATION
 
@@ -23,14 +14,10 @@ To install this module type the following:
 
 DEPENDENCIES
 
-This module requires these other modules and libraries:
-
-  blah blah blah
+This module requires no non-core dependencies
 
 COPYRIGHT AND LICENCE
 
-Put the correct copyright and licence information here.
-
 Copyright (C) 2014 by Marius Gavrilescu
 
 This library is free software; you can redistribute it and/or modify
This page took 0.010323 seconds and 4 git commands to generate.