aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README58
1 files changed, 58 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..835d16c
--- /dev/null
+++ b/README
@@ -0,0 +1,58 @@
+NAME
+ Arctica::Core - Core Perl modules for the Arctica Framework
+
+SYNOPSIS
+ use Arctica::Core;
+
+ <usage-example-code>
+
+DESCRIPTION
+
+ <Introduction text>
+
+ Package Variables
+
+ <Some overall explanation>
+
+ $Arctica::Core::<var1>
+ <Explanation on var1>.
+
+ $Arctica::Core::<var2>
+ <Explanation on var2>.
+
+ Class Methods
+
+ <method-name-1>
+
+ This method does ....
+
+ <method-name-1>
+
+ This method does ....
+
+ Instance Methods
+
+ <method-name-1>
+
+ This method does ....
+
+ <method-name-1>
+
+ This method does ....
+
+ Overloaded Operators
+
+ <overloaded-operator-1>
+
+ Explanation on this...
+
+SEE ALSO
+ Arctica::GUI, <others>, perl.
+
+AUTHOR
+ AUTHOR_FULLNAME <AUTHOR_MAILADDRESS>
+
+COPYRIGHT
+ Copyright (c) 2015-2016 Arctica Project. All rights reserved.
+ This module is free software; you can redistribute it and/or modify it
+ under the same terms of the <LICENSE> license.