Project structure change

1 files changed, 63 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 00000000..f0860fa3
--- /dev/null
+++ b/README
@@ -0,0 +1,63 @@
+AdminPanel-Shared
+
+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 to get an idea of the module's 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.
+
+
+INSTALLATION
+
+To install this module, run the following commands:
+
+	perl Makefile.PL
+	make
+	make test
+	make install
+
+SUPPORT AND DOCUMENTATION
+
+After installing, you can find documentation for this module with the
+perldoc command.
+
+    perldoc AdminPanel
+
+You can also look for information at:
+
+    RT, CPAN's request tracker (report bugs here)
+        http://rt.cpan.org/NoAuth/Bugs.html?Dist=AdminPanel-Shared
+
+    AnnoCPAN, Annotated CPAN documentation
+        http://annocpan.org/dist/AdminPanel-Shared
+
+    CPAN Ratings
+        http://cpanratings.perl.org/d/AdminPanel-Shared
+
+    Search CPAN
+        http://search.cpan.org/dist/AdminPanel-Shared/
+
+
+LICENSE AND COPYRIGHT
+
+Copyright (C) 2012-2014 Angelo Naselli, Matteo Pasotti, Steven Tucker
+
+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; version 2 dated June, 1991 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.
+
+A copy of the GNU General Public License is available in the source tree;
+if not, write to the Free Software Foundation, Inc.,
+59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+