diff options
author | Yorhel <git@yorhel.nl> | 2008-10-26 11:30:08 +0100 |
---|---|---|
committer | Yorhel <git@yorhel.nl> | 2008-10-26 11:30:08 +0100 |
commit | 0a22ed97765c4f8937abae863c36e094b2df217f (patch) | |
tree | c26652425b5d18736757b02e8d1590ceca544e5b | |
parent | da8c2ec3805c3086e68ae1f28591929b2dac2bcc (diff) |
Proper 'packaging' + readme + license file
I've chosen a MIT license for this project, I'm pretty sure nobody
would disagree with that.
-rw-r--r-- | .gitignore | 3 | ||||
-rw-r--r-- | COPYING | 20 | ||||
-rw-r--r-- | README | 42 | ||||
-rw-r--r-- | README.concept (renamed from concept) | 0 | ||||
-rw-r--r-- | examples/VNDB/DB/Misc.pm (renamed from lib/VNDB/DB/Misc.pm) | 0 | ||||
-rw-r--r-- | examples/VNDB/Handler/Example.pm (renamed from lib/VNDB/Handler/Example.pm) | 0 | ||||
-rw-r--r-- | examples/VNDB/Handler/Forms.pm (renamed from lib/VNDB/Handler/Forms.pm) | 0 | ||||
-rwxr-xr-x | examples/vndb.pl (renamed from util/vndb.pl) | 20 | ||||
-rw-r--r-- | notes | 12 |
9 files changed, 72 insertions, 25 deletions
@@ -1,2 +1 @@ -/data/config.pl -/data/logs/ +/data/ @@ -0,0 +1,20 @@ +Copyright (c) 2008 Yoran Heling + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. @@ -0,0 +1,42 @@ +YAWF - Yet Another Website Framework [or] Yorhel's Awesome Website Framework + + + This package provides the following set of modules: + + YAWF + YAWF::DB + YAWF::XML + YAWF::Misc + YAWF::Request + YAWF::Response + + + Dependencies: + + Required + DBI + CGI::Minimal + CGI::Cookie::XS + + Optional + FCGI to run in a FastCGI environment + Time::HiRes with debugging enabled + PerlIO::gzip output compression + + + Notes on usage + + The documentation is still quite lacking, see README.concept for a general + overview, check examples/ for some examples, and read the source code for + more information. + + The API of this module is in flux, and I am not one to care much about + backwards compatibility. If you decide to use YAWF, either get one version + and stick to that, or be sure to read all commit messages if you want to + stay up-to-date. + + + Contact + + #vndb @ irc.synirc.net + diff --git a/lib/VNDB/DB/Misc.pm b/examples/VNDB/DB/Misc.pm index b83a66d..b83a66d 100644 --- a/lib/VNDB/DB/Misc.pm +++ b/examples/VNDB/DB/Misc.pm diff --git a/lib/VNDB/Handler/Example.pm b/examples/VNDB/Handler/Example.pm index 0fdc788..0fdc788 100644 --- a/lib/VNDB/Handler/Example.pm +++ b/examples/VNDB/Handler/Example.pm diff --git a/lib/VNDB/Handler/Forms.pm b/examples/VNDB/Handler/Forms.pm index 11a5735..11a5735 100644 --- a/lib/VNDB/Handler/Forms.pm +++ b/examples/VNDB/Handler/Forms.pm diff --git a/util/vndb.pl b/examples/vndb.pl index f969420..fb4aebd 100755 --- a/util/vndb.pl +++ b/examples/vndb.pl @@ -13,30 +13,28 @@ use warnings; use Cwd 'abs_path'; our $ROOT; BEGIN { - ($ROOT = abs_path $0) =~ s{/util/vndb\.pl$}{}; + ($ROOT = abs_path $0) =~ s{/examples/vndb\.pl$}{}; } +# make sure YAWF is findable use lib $ROOT.'/lib'; +# and make sure our own example modules are, too +use lib $ROOT.'/examples'; + + use YAWF; -# default options -our %O = ( +YAWF::init( + # required namespace => 'VNDB', db_login => [ 'dbi:Pg:dbname=vndb', 'vndb', 'passwd' ], + # optional debug => 1, logfile => $ROOT.'/data/logs/err.log', -); - - -# ...can be overwritten in data/config.pl -require $ROOT.'/data/config.pl' if -e $ROOT.'/data/config.pl'; - -YAWF::init( - %O, error_404_handler => \&page_404, ); @@ -1,12 +0,0 @@ - Random notes while developing YAWF - -Dependencies: - Required - DBI - CGI::Minimal - CGI::Cookie::XS - Optional - FCGI to run in a FastCGI environment - Time::HiRes with debugging enabled - PerlIO::gzip output compression - |