aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMike Gabriel <mike.gabriel@das-netzwerkteam.de>2016-10-19 11:14:57 +0200
committerMike Gabriel <mike.gabriel@das-netzwerkteam.de>2016-10-19 11:14:57 +0200
commitfafffe8978a700edfef3adc12c82e8a338f43922 (patch)
tree604381f699b0a20bc3213a7403a15dcb89922efd /README
parentff552778a10f474f639ac3930ca86b4ba3a64aaf (diff)
downloadperl-Arctica-Telekinesis-Application-Gtk3-fafffe8978a700edfef3adc12c82e8a338f43922.tar.gz
perl-Arctica-Telekinesis-Application-Gtk3-fafffe8978a700edfef3adc12c82e8a338f43922.tar.bz2
perl-Arctica-Telekinesis-Application-Gtk3-fafffe8978a700edfef3adc12c82e8a338f43922.zip
Add formal Perl files.
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..ba16bf3
--- /dev/null
+++ b/README
@@ -0,0 +1,58 @@
+NAME
+ Arctica::Telekinesis::Application::Gtk3 - Core Perl modules for the Arctica Framework
+
+SYNOPSIS
+ use Arctica::Telekinesis::Application::Gtk3;
+
+ <usage-example-code>
+
+DESCRIPTION
+
+ <Introduction text>
+
+ Package Variables
+
+ <Some overall explanation>
+
+ $Arctica::Telekinesis::Application::Gtk3::<var1>
+ <Explanation on var1>.
+
+ $Arctica::Telekinesis::Application::Gtk3::<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::Telekinesis::Server, Arctica::Telekinesis::Client, 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.