summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAustin Ziegler <austin@zieglers.ca>2013-01-21 01:29:21 -0500
committerAustin Ziegler <austin@zieglers.ca>2013-01-21 01:29:21 -0500
commit1dc0f291769e487a21b30e004626ca307c97c950 (patch)
tree6069f2f5018809e68eb698af98854a872964b473
parentf4e45639e43c27ecec95e95a115188cf42f7d703 (diff)
downloaddiff-lcs-1dc0f291769e487a21b30e004626ca307c97c950.tar.gz
Final preparation for the 1.2 release.
- Added a Contributing.rdoc for contribution guidelines. - Cleaned up the README.rdoc. - Fixed the presentation of the GPL and Artistic licenses. - Made all of the development dependencies explicit. - Other minor items cleaned up.
-rw-r--r--.gitignore1
-rw-r--r--.travis.yml3
-rw-r--r--Contributing.rdoc63
-rw-r--r--Gemfile9
-rw-r--r--History.rdoc7
-rw-r--r--Manifest.txt3
-rw-r--r--README.rdoc71
-rw-r--r--Rakefile12
-rw-r--r--diff-lcs.gemspec39
-rw-r--r--docs/artistic.html289
-rw-r--r--docs/artistic.txt127
11 files changed, 296 insertions, 328 deletions
diff --git a/.gitignore b/.gitignore
index 415f372..ecfc182 100644
--- a/.gitignore
+++ b/.gitignore
@@ -13,3 +13,4 @@ coverage.info
.DS_Store
website/index.html
research/
+.source_index
diff --git a/.travis.yml b/.travis.yml
index 4918ac1..d9aeccb 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -6,8 +6,7 @@ before_script:
- rake travis:before -t
language: ruby
notifications:
- email:
- - austin@rubyforge.org
+ email: false
rvm:
- 1.9.3
- 1.9.2
diff --git a/Contributing.rdoc b/Contributing.rdoc
new file mode 100644
index 0000000..45fa7ad
--- /dev/null
+++ b/Contributing.rdoc
@@ -0,0 +1,63 @@
+== Contributing
+
+I value any contribution to Diff::LCS you can provide: a bug report, a feature
+request, or code contributions.
+
+Code contributions to Diff::LCS are especially <del>welcome</del>encouraged.
+Because Diff::LCS is a complex codebase, there are a few guidelines:
+
+* Changes <strong>will not</strong> be accepted without tests.
+* The test suite is written with RSpec.‡
+* Match my coding style.
+* Use a thoughtfully-named topic branch that contains your change. Rebase your
+ commits into logical chunks as necessary.
+* Use {quality commit messages}[http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html].
+* Do not change the version number; when your patch is accepted and a release
+ is made, the version will be updated at that point.
+* Submit a GitHub pull request with your changes.
+* New features require new documentation.
+
+=== Test Dependencies
+
+To run the test suite, you will need to install the development dependencies
+for Diff::LCS. If you have Bundler, you can accomplish this easily:
+
+ $ bundle install
+
+Diff::LCS uses Ryan Davis’s excellent {Hoe}[https://github.com/seattlerb/hoe]
+to manage the release process, and it adds a number of rake tasks. You will
+mostly be interested in:
+
+ $ rake
+
+which runs the tests the same way that:
+
+ $ rake spec
+ $ rake test
+ $ rake travis
+
+will do.
+
+=== Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+* Fork the project.
+* Clone down your fork (+git clone git://github.com/<username>/diff-lcs.git+).
+* Create a topic branch to contain your change (+git checkout -b my\_awesome\_feature+).
+* Hack away, add tests. Not necessarily in that order.
+* Make sure everything still passes by running `rake`.
+* If necessary, rebase your commits into logical chunks, without errors.
+* Push the branch up (+git push origin my\_awesome\_feature+).
+* Create a pull request against halostatue/diff-lcs and describe what your
+ change does and the why you think it should be merged.
+
+=== Contributors
+
+* Austin Ziegler created Diff::LCS.
+
+Thanks to everyone else who has contributed to Diff::LCS:
+
+* Kenichi Kamiya
+* Michael Granger
+* Vít Ondruch
diff --git a/Gemfile b/Gemfile
index 1488dd4..e095f3a 100644
--- a/Gemfile
+++ b/Gemfile
@@ -5,11 +5,16 @@
source "https://rubygems.org/"
-gem "hoe-highline", "~>0.1.0", :group => [:development, :test]
-gem "hoe-mercurial", "~>1.4.0", :group => [:development, :test]
+gem "rubyforge", ">=2.0.4", :group => [:development, :test]
gem "rdoc", "~>3.10", :group => [:development, :test]
gem "rspec", "~>2.0", :group => [:development, :test]
gem "rake", "~>10.0", :group => [:development, :test]
+gem "hoe-bundler", "~>1.2.0", :group => [:development, :test]
+gem "hoe-doofus", "~>1.0.0", :group => [:development, :test]
+gem "hoe-gemspec", "~>1.0.0", :group => [:development, :test]
+gem "hoe-git", "~>1.5.0", :group => [:development, :test]
+gem "hoe-rubygems", "~>1.0.0", :group => [:development, :test]
+gem "hoe-travis", "~>1.2", :group => [:development, :test]
gem "hoe", "~>3.4", :group => [:development, :test]
# vim: syntax=ruby
diff --git a/History.rdoc b/History.rdoc
index d016bb1..9874c49 100644
--- a/History.rdoc
+++ b/History.rdoc
@@ -1,6 +1,4 @@
== 1.2.0 / 2013-01-20
-* This is being released as version 1.2 because of the feature changes and
- internal migration.
* Minor Enhancements:
* Added special case handling for Diff::LCS.patch so that it handles patches
that are empty or contain no changes.
@@ -14,7 +12,7 @@
and added specs in pull request #8. Thanks!
https://github.com/halostatue/diff-lcs/issues/8
* Made the code auto-testable.
- * Vit Ondruch (voxik) provided the latest version of the GPL2 license file in
+ * Vít Ondruch (voxik) provided the latest version of the GPL2 license file in
pull request #10. Thanks! https://github.com/halostatue/diff-lcs/issues/10
* Fixed a documentation issue with the includable versions of #patch! and
#unpatch! where they implied that they would replace the original value.
@@ -26,13 +24,14 @@
* Code Style Changes:
* Removed trailing spaces.
* Calling class methods using '.' instead of '::'.
- * Vit Ondruch (voxik) removed unnecessary shebangs in pull request #9.
+ * Vít Ondruch (voxik) removed unnecessary shebangs in pull request #9.
Thanks! https://github.com/halostatue/diff-lcs/issues/9
* Kenichi Kamiya (kachick) removed some warnings of an unused variable in
lucky pull request #13. https://github.com/halostatue/diff-lcs/issues/13
Thanks!
* Embarked on a major refactoring to make the files a little more manageable
and understand the code on a deeper level.
+ * Adding to http://travis-ci.org.
== 1.1.3 / 2011-08-27
* Converted to 'hoe' for release.
diff --git a/Manifest.txt b/Manifest.txt
index 039f32f..ff96f2f 100644
--- a/Manifest.txt
+++ b/Manifest.txt
@@ -1,6 +1,7 @@
.autotest
.rspec
.travis.yml
+Contributing.rdoc
Gemfile
History.rdoc
License.rdoc
@@ -12,7 +13,7 @@ bin/htmldiff
bin/ldiff
diff-lcs.gemspec
docs/COPYING.txt
-docs/artistic.html
+docs/artistic.txt
lib/diff-lcs.rb
lib/diff/lcs.rb
lib/diff/lcs/array.rb
diff --git a/README.rdoc b/README.rdoc
index a887b16..a2d92ea 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -1,29 +1,18 @@
-= diff-lcs
+= Diff::LCS
-== Description
-Diff::LCS is a port of Perl's Algorithm::Diff that uses the McIlroy-Hunt
-longest common subsequence (LCS) algorithm to compute intelligent differences
-between two sequenced enumerable containers. The implementation is based on
-Mario I. Wolczko's {Smalltalk version 1.2}[ftp://st.cs.uiuc.edu/pub/Smalltalk/MANCHESTER/manchester/4.0/diff.st]
-(1993) and Ned Konz's Perl version
-{Algorithm::Diff 1.15}[http://search.cpan.org/~nedkonz/Algorithm-Diff-1.15/].
-
-This is release 1.1.3, fixing several small bugs found over the years. Version
-1.1.0 added new features, including the ability to #patch and #unpatch changes
-as well as a new contextual diff callback, Diff::LCS::ContextDiffCallbacks,
-that should improve the context sensitivity of patching.
+home :: http://diff-lcs.rubyforge.org/
+code :: https://github.com/halostatue/diff-lcs
+bugs :: https://github.com/halostatue/diff-lcs/issues
+rdoc :: http://rubydoc.info/github/halostatue/diff-lcs
-This library is called Diff::LCS because of an early version of Algorithm::Diff
-which was restrictively licensed. This version has seen a minor license change:
-instead of being under Ruby's license as an option, the third optional license
-is the MIT license.
-
-== Where
+== Description
-* {GitHub}[https://github.com/halostatue/diff-lcs]
+Diff::LCS computes the difference between two Enumerable sequences using the
+McIlroy-Hunt longest common subsequence (LCS) algorithm. It includes utilities
+to create a simple HTML diff output format and a standard diff-like tool.
-This is the new home of Diff::LCS (diff-lcs). The Ruwiki page still refers to
-it, but development is not happening there any longer.
+This is release 1.2. Everyone is strongly encouraged to upgrade to this version
+as it fixes all known outstanding issues.
== Synopsis
@@ -64,9 +53,45 @@ extended for use this way.
Note that Diff::LCS requires a sequenced enumerable container, which means that
the order of enumeration is both predictable and consistent for the same set of
-data. While it is theoretically possible to generate a diff for unordereded
+data. While it is theoretically possible to generate a diff for an unordered
hash, it will only be meaningful if the enumeration of the hashes is
consistent. In general, this will mean that containers that behave like String
or Array will perform best.
+== History
+
+Diff::LCS is a port of Perl's Algorithm::Diff that uses the McIlroy-Hunt
+longest common subsequence (LCS) algorithm to compute intelligent differences
+between two sequenced enumerable containers. The implementation is based on
+Mario I. Wolczko's {Smalltalk version 1.2}[ftp://st.cs.uiuc.edu/pub/Smalltalk/MANCHESTER/manchester/4.0/diff.st]
+(1993) and Ned Konz's Perl version
+{Algorithm::Diff 1.15}[http://search.cpan.org/~nedkonz/Algorithm-Diff-1.15/].
+
+This library is called Diff::LCS because of an early version of Algorithm::Diff
+which was restrictively licensed.
+
+== Continuous Integration Status
+
+{<img src="https://travis-ci.org/halostatue/diff-lcs.png" />}[https://travis-ci.org/halostatue/diff-lcs]
+
+== Contributing
+
+If you'd like to hack on Diff::LCS, start by forking the repo on GitHub:
+
+https://github.com/halostatue/diff-lcs
+
+The best way to get your changes merged back into core is as follows:
+
+1. Clone down your fork.
+2. Create a thoughtfully named topic branch to contain your change.
+3. Hack away.
+4. Add tests and make sure everything still passes by running rake.
+5. If you are adding new functionality, document it in the README.
+6. Do not change the version number, we will do that on our end.
+7. If necessary, rebase your commits into logical chunks, without errors.
+8. Push the branch up to GitHub.
+9. Send a pull request for your branch
+
+:include: Contributing.rdoc
+
:include: License.rdoc
diff --git a/Rakefile b/Rakefile
index 9e22e75..4ed25c3 100644
--- a/Rakefile
+++ b/Rakefile
@@ -8,17 +8,29 @@ Hoe.plugin :bundler
Hoe.plugin :doofus
Hoe.plugin :gemspec
Hoe.plugin :git
+Hoe.plugin :rubyforge
+Hoe.plugin :email
Hoe.plugin :travis
Hoe.spec 'diff-lcs' do
developer('Austin Ziegler', 'austin@rubyforge.org')
+ self.remote_rdoc_dir = '.'
+ self.rsync_args << ' --exclude=statsvn/'
+
self.history_file = 'History.rdoc'
self.readme_file = 'README.rdoc'
self.extra_rdoc_files = FileList["*.rdoc"].to_a
self.extra_dev_deps << ['rspec', '~> 2.0']
self.extra_dev_deps << ['rake', '~> 10.0']
+ self.extra_dev_deps << ['hoe-bundler', '~> 1.2.0']
+ self.extra_dev_deps << ['hoe-doofus', '~> 1.0.0']
+ self.extra_dev_deps << ['hoe-gemspec', '~> 1.0.0']
+ self.extra_dev_deps << ['hoe-git', '~> 1.5.0']
+ self.extra_dev_deps << ['hoe-rubygems', '~> 1.0.0']
+# self.extra_dev_deps << ['hoe-seattlerb', '~> 1.2.9, 1.2.8']
+ self.extra_dev_deps << ['hoe-travis', '~> 1.2']
end
unless Rake::Task.task_defined? :test
diff --git a/diff-lcs.gemspec b/diff-lcs.gemspec
index a179ac3..0bbc4fe 100644
--- a/diff-lcs.gemspec
+++ b/diff-lcs.gemspec
@@ -2,37 +2,62 @@
Gem::Specification.new do |s|
s.name = "diff-lcs"
- s.version = "1.2.0.20130120032021"
+ s.version = "1.2.0'
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Austin Ziegler"]
- s.date = "2013-01-20"
- s.description = "Diff::LCS is a port of Perl's Algorithm::Diff that uses the McIlroy-Hunt\nlongest common subsequence (LCS) algorithm to compute intelligent differences\nbetween two sequenced enumerable containers. The implementation is based on\nMario I. Wolczko's {Smalltalk version 1.2}[ftp://st.cs.uiuc.edu/pub/Smalltalk/MANCHESTER/manchester/4.0/diff.st]\n(1993) and Ned Konz's Perl version\n{Algorithm::Diff 1.15}[http://search.cpan.org/~nedkonz/Algorithm-Diff-1.15/].\n\nThis is release 1.1.3, fixing several small bugs found over the years. Version\n1.1.0 added new features, including the ability to #patch and #unpatch changes\nas well as a new contextual diff callback, Diff::LCS::ContextDiffCallbacks,\nthat should improve the context sensitivity of patching.\n\nThis library is called Diff::LCS because of an early version of Algorithm::Diff\nwhich was restrictively licensed. This version has seen a minor license change:\ninstead of being under Ruby's license as an option, the third optional license\nis the MIT license."
+ s.date = "2013-01-21"
+ s.description = "Diff::LCS computes the difference between two Enumerable sequences using the\nMcIlroy-Hunt longest common subsequence (LCS) algorithm. It includes utilities\nto create a simple HTML diff output format and a standard diff-like tool.\n\nThis is release 1.2. Everyone is strongly encouraged to upgrade to this version\nas it fixes all known outstanding issues."
s.email = ["austin@rubyforge.org"]
s.executables = ["htmldiff", "ldiff"]
- s.extra_rdoc_files = ["History.rdoc", "License.rdoc", "Manifest.txt", "README.rdoc", "docs/COPYING.txt", "History.rdoc", "License.rdoc", "README.rdoc"]
- s.files = [".autotest", ".rspec", "History.rdoc", "License.rdoc", "Manifest.txt", "README.rdoc", "Rakefile", "autotest/discover.rb", "bin/htmldiff", "bin/ldiff", "diff-lcs.gemspec", "docs/COPYING.txt", "docs/artistic.html", "lib/diff-lcs.rb", "lib/diff/lcs.rb", "lib/diff/lcs/array.rb", "lib/diff/lcs/block.rb", "lib/diff/lcs/callbacks.rb", "lib/diff/lcs/change.rb", "lib/diff/lcs/htmldiff.rb", "lib/diff/lcs/hunk.rb", "lib/diff/lcs/internals.rb", "lib/diff/lcs/ldiff.rb", "lib/diff/lcs/string.rb", "spec/change_spec.rb", "spec/diff_spec.rb", "spec/issues_spec.rb", "spec/lcs_spec.rb", "spec/patch_spec.rb", "spec/sdiff_spec.rb", "spec/spec_helper.rb", "spec/traverse_balanced_spec.rb", "spec/traverse_sequences_spec.rb", ".gemtest"]
+ s.extra_rdoc_files = ["Contributing.rdoc", "History.rdoc", "License.rdoc", "Manifest.txt", "README.rdoc", "docs/COPYING.txt", "docs/artistic.txt", "Contributing.rdoc", "History.rdoc", "License.rdoc", "README.rdoc"]
+ s.files = [".autotest", ".rspec", ".travis.yml", "Contributing.rdoc", "Gemfile", "History.rdoc", "License.rdoc", "Manifest.txt", "README.rdoc", "Rakefile", "autotest/discover.rb", "bin/htmldiff", "bin/ldiff", "diff-lcs.gemspec", "docs/COPYING.txt", "docs/artistic.txt", "lib/diff-lcs.rb", "lib/diff/lcs.rb", "lib/diff/lcs/array.rb", "lib/diff/lcs/block.rb", "lib/diff/lcs/callbacks.rb", "lib/diff/lcs/change.rb", "lib/diff/lcs/htmldiff.rb", "lib/diff/lcs/hunk.rb", "lib/diff/lcs/internals.rb", "lib/diff/lcs/ldiff.rb", "lib/diff/lcs/string.rb", "spec/change_spec.rb", "spec/diff_spec.rb", "spec/issues_spec.rb", "spec/lcs_spec.rb", "spec/patch_spec.rb", "spec/sdiff_spec.rb", "spec/spec_helper.rb", "spec/traverse_balanced_spec.rb", "spec/traverse_sequences_spec.rb", ".gemtest"]
+ s.homepage = "http://diff-lcs.rubyforge.org/"
s.rdoc_options = ["--main", "README.rdoc"]
s.require_paths = ["lib"]
- s.rubyforge_project = "ruwiki"
+ s.rubyforge_project = "diff-lcs"
s.rubygems_version = "1.8.24"
- s.summary = "Diff::LCS is a port of Perl's Algorithm::Diff that uses the McIlroy-Hunt longest common subsequence (LCS) algorithm to compute intelligent differences between two sequenced enumerable containers"
+ s.summary = "Diff::LCS computes the difference between two Enumerable sequences using the McIlroy-Hunt longest common subsequence (LCS) algorithm"
if s.respond_to? :specification_version then
s.specification_version = 3
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+ s.add_development_dependency(%q<rubyforge>, [">= 2.0.4"])
s.add_development_dependency(%q<rdoc>, ["~> 3.10"])
s.add_development_dependency(%q<rspec>, ["~> 2.0"])
+ s.add_development_dependency(%q<rake>, ["~> 10.0"])
+ s.add_development_dependency(%q<hoe-bundler>, ["~> 1.2.0"])
+ s.add_development_dependency(%q<hoe-doofus>, ["~> 1.0.0"])
+ s.add_development_dependency(%q<hoe-gemspec>, ["~> 1.0.0"])
+ s.add_development_dependency(%q<hoe-git>, ["~> 1.5.0"])
+ s.add_development_dependency(%q<hoe-rubygems>, ["~> 1.0.0"])
+ s.add_development_dependency(%q<hoe-travis>, ["~> 1.2"])
s.add_development_dependency(%q<hoe>, ["~> 3.4"])
else
+ s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
s.add_dependency(%q<rdoc>, ["~> 3.10"])
s.add_dependency(%q<rspec>, ["~> 2.0"])
+ s.add_dependency(%q<rake>, ["~> 10.0"])
+ s.add_dependency(%q<hoe-bundler>, ["~> 1.2.0"])
+ s.add_dependency(%q<hoe-doofus>, ["~> 1.0.0"])
+ s.add_dependency(%q<hoe-gemspec>, ["~> 1.0.0"])
+ s.add_dependency(%q<hoe-git>, ["~> 1.5.0"])
+ s.add_dependency(%q<hoe-rubygems>, ["~> 1.0.0"])
+ s.add_dependency(%q<hoe-travis>, ["~> 1.2"])
s.add_dependency(%q<hoe>, ["~> 3.4"])
end
else
+ s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
s.add_dependency(%q<rdoc>, ["~> 3.10"])
s.add_dependency(%q<rspec>, ["~> 2.0"])
+ s.add_dependency(%q<rake>, ["~> 10.0"])
+ s.add_dependency(%q<hoe-bundler>, ["~> 1.2.0"])
+ s.add_dependency(%q<hoe-doofus>, ["~> 1.0.0"])
+ s.add_dependency(%q<hoe-gemspec>, ["~> 1.0.0"])
+ s.add_dependency(%q<hoe-git>, ["~> 1.5.0"])
+ s.add_dependency(%q<hoe-rubygems>, ["~> 1.0.0"])
+ s.add_dependency(%q<hoe-travis>, ["~> 1.2"])
s.add_dependency(%q<hoe>, ["~> 3.4"])
end
end
diff --git a/docs/artistic.html b/docs/artistic.html
deleted file mode 100644
index 9cd071b..0000000
--- a/docs/artistic.html
+++ /dev/null
@@ -1,289 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>The "Artistic License" - dev.perl.org</title>
- <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
-
-
- <link rel="stylesheet" type="text/css" href="http://cdn.pimg.net/css/leostyle.vffcd481.css">
- <link rel="stylesheet" type="text/css" href="http://cdn.pimg.net/css/dev.v5f7fab3.css">
-
-
- <link rel="shortcut icon" href="http://cdn.pimg.net/favicon.v249dfa7.ico">
-
-
-
- <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js" type="text/javascript" charset="utf-8"></script>
- <script src="http://cdn.pimg.net/js/jquery.corner.v84b7681.js" type="text/javascript" charset="utf-8"></script>
- <script src="http://cdn.pimg.net/js/leo.v9872b9c.js" type="text/javascript" charset="utf-8"></script>
-
-</head>
-<body>
-
-<div id="header_holder">
- <div class="sub_holder">
- <div id="page_image"></div>
- <h1>
- The "Artistic License"
- </h1>
- <div id="logo_holder">
-
-
-
- <a href="/"><img src="http://cdn.pimg.net/images/camel_head.v25e738a.png" id="logo" alt="Perl programming" height="65" align="right" /></a>
-
-
- <span>dev.perl.org</span>
-
- </div>
- </div>
-</div>
-
-<div id="nav">
- <div class="sub_holder">
- <ul>
- <li>
- <a href="/">Home</a>
- </li>
- <li class="">
- <a href="/perl5/">Perl 5</a>
- </li>
- <li class="">
- <a href="/perl6/">Perl 6</a>
- </li>
-
-</ul>
-
- </div>
-</div>
-
-<div id="crum_holder">
- <div id="crum" class="sub_holder">
- &nbsp;
- </div>
-</div>
-
-<div id="content_holder">
- <div id="content" class="sub_holder">
- <div id="main">
-
-<PRE>
-
-<A style="float:right"
- HREF="http://www.opensource.org/licenses/artistic-license.php"
-><IMG BORDER=0 SRC="osi-certified-90x75.gif"
-></A>
-
- The "Artistic License"
-
- Preamble
-
-The intent of this document is to state the conditions under which a
-Package may be copied, such that the Copyright Holder maintains some
-semblance of artistic control over the development of the package,
-while giving the users of the package the right to use and distribute
-the Package in a more-or-less customary fashion, plus the right to make
-reasonable modifications.
-
-Definitions:
-
- "Package" refers to the collection of files distributed by the
- Copyright Holder, and derivatives of that collection of files
- created through textual modification.
-
- "Standard Version" refers to such a Package if it has not been
- modified, or has been modified in accordance with the wishes
- of the Copyright Holder as specified below.
-
- "Copyright Holder" is whoever is named in the copyright or
- copyrights for the package.
-
- "You" is you, if you're thinking about copying or distributing
- this Package.
-
- "Reasonable copying fee" is whatever you can justify on the
- basis of media cost, duplication charges, time of people involved,
- and so on. (You will not be required to justify it to the
- Copyright Holder, but only to the computing community at large
- as a market that must bear the fee.)
-
- "Freely Available" means that no fee is charged for the item
- itself, though there may be fees involved in handling the item.
- It also means that recipients of the item may redistribute it
- under the same conditions they received it.
-
-1. You may make and give away verbatim copies of the source form of the
-Standard Version of this Package without restriction, provided that you
-duplicate all of the original copyright notices and associated disclaimers.
-
-2. You may apply bug fixes, portability fixes and other modifications
-derived from the Public Domain or from the Copyright Holder. A Package
-modified in such a way shall still be considered the Standard Version.
-
-3. You may otherwise modify your copy of this Package in any way, provided
-that you insert a prominent notice in each changed file stating how and
-when you changed that file, and provided that you do at least ONE of the
-following:
-
- a) place your modifications in the Public Domain or otherwise make them
- Freely Available, such as by posting said modifications to Usenet or
- an equivalent medium, or placing the modifications on a major archive
- site such as uunet.uu.net, or by allowing the Copyright Holder to include
- your modifications in the Standard Version of the Package.
-
- b) use the modified Package only within your corporation or organization.
-
- c) rename any non-standard executables so the names do not conflict
- with standard executables, which must also be provided, and provide
- a separate manual page for each non-standard executable that clearly
- documents how it differs from the Standard Version.
-
- d) make other distribution arrangements with the Copyright Holder.
-
-4. You may distribute the programs of this Package in object code or
-executable form, provided that you do at least ONE of the following:
-
- a) distribute a Standard Version of the executables and library files,
- together with instructions (in the manual page or equivalent) on where
- to get the Standard Version.
-
- b) accompany the distribution with the machine-readable source of
- the Package with your modifications.
-
- c) give non-standard executables non-standard names, and clearly
- document the differences in manual pages (or equivalent), together
- with instructions on where to get the Standard Version.
-
- d) make other distribution arrangements with the Copyright Holder.
-
-5. You may charge a reasonable copying fee for any distribution of this
-Package. You may charge any fee you choose for support of this
-Package. You may not charge a fee for this Package itself. However,
-you may distribute this Package in aggregate with other (possibly
-commercial) programs as part of a larger (possibly commercial) software
-distribution provided that you do not advertise this Package as a
-product of your own. You may embed this Package's interpreter within
-an executable of yours (by linking); this shall be construed as a mere
-form of aggregation, provided that the complete Standard Version of the
-interpreter is so embedded.
-
-6. The scripts and library files supplied as input to or produced as
-output from the programs of this Package do not automatically fall
-under the copyright of this Package, but belong to whoever generated
-them, and may be sold commercially, and may be aggregated with this
-Package. If such scripts or library files are aggregated with this
-Package via the so-called "undump" or "unexec" methods of producing a
-binary executable image, then distribution of such an image shall
-neither be construed as a distribution of this Package nor shall it
-fall under the restrictions of Paragraphs 3 and 4, provided that you do
-not represent such an executable image as a Standard Version of this
-Package.
-
-7. C subroutines (or comparably compiled subroutines in other
-languages) supplied by you and linked into this Package in order to
-emulate subroutines and variables of the language defined by this
-Package shall not be considered part of this Package, but are the
-equivalent of input as in Paragraph 6, provided these subroutines do
-not change the language in any way that would cause it to fail the
-regression tests for the language.
-
-8. Aggregation of this Package with a commercial distribution is always
-permitted provided that the use of this Package is embedded; that is,
-when no overt attempt is made to make this Package's interfaces visible
-to the end user of the commercial distribution. Such use shall not be
-construed as a distribution of this Package.
-
-9. The name of the Copyright Holder may not be used to endorse or promote
-products derived from this software without specific prior written permission.
-
-10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
- The End
-</PRE>
-
- </div>
- <div id="short_lists" class="short_lists">
-
-
-
-
-
-
-
-
-
- <div id="spacer_for_google"></div>
-
- </div>
- </div>
-</div>
-<div style="clear:both"></div>
-
-<div id="footer">
- <div class="sub_holder">
-
-
- <p class="sites">
- &nbsp;When you need <em>Perl</em> think <strong>Perl.org</strong>: <a href="http://www.perl.org/">www</a> | <a href="http://blogs.perl.org/">blogs</a> | <a href="http://jobs.perl.org/">jobs</a> | <a href="http://learn.perl.org/">learn</a> <!-- | <a href="http://lists.perl.org/">lists</a> --> | <a href="http://dev.perl.org/">dev</a>
- </p>
- <p class="copyright">
- <a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/us/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-nc-nd/3.0/us/80x15.png"></a> © 2002-2011 Perl.org | <a href="/siteinfo.html">Site Info</a>
- </p>
-
-
-
-
- <div style="clear:both"></div>
- <div id="google_translate_element"></div><script type="text/javascript">
-function googleTranslateElementInit() {
- new google.translate.TranslateElement({
- pageLanguage: 'en',
- autoDisplay: false
- ,
- gaTrack: true,
- gaId: 'UA-50555-6'
- }, 'google_translate_element');
- }
- </script><script src="http://translate.google.com/translate_a/element.js?cb=googleTranslateElementInit" type="text/javascript">
-</script>
- </div>
-</div>
-
-
-<!--[if lt IE 7]>
-<div style='border: 1px solid #F7941D; background: #FEEFDA; text-align: center; clear: both; height: 75px; position: relative; margin-top: 2em;'>
- <div style='position: absolute; right: 3px; top: 3px; font-family: courier new; font-weight: bold;'><a href='#' onclick='javascript:this.parentNode.parentNode.style.display="none"; return false;'><img src='http://www.ie6nomore.com/files/theme/ie6nomore-cornerx.jpg' style='border: none;' alt='Close this notice'/></a></div>
- <div style='width: 640px; margin: 0 auto; text-align: left; padding: 0; overflow: hidden; color: black;'>
- <div style='width: 75px; float: left;'><img src='http://www.ie6nomore.com/files/theme/ie6nomore-warning.jpg' alt='Warning!'/></div>
- <div style='width: 275px; float: left; font-family: Arial, sans-serif;'>
- <div style='font-size: 14px; font-weight: bold; margin-top: 12px;'>You are using an outdated browser</div>
- <div style='font-size: 12px; margin-top: 6px; line-height: 12px;'>For a better experience using this site, please upgrade to a modern web browser.</div>
- </div>
- <div style='width: 75px; float: left;'><a href='http://www.firefox.com' target='_blank'><img src='http://www.ie6nomore.com/files/theme/ie6nomore-firefox.jpg' style='border: none;' alt='Get Firefox 3.5'/></a></div>
- <div style='width: 75px; float: left;'><a href='http://www.browserforthebetter.com/download.html' target='_blank'><img src='http://www.ie6nomore.com/files/theme/ie6nomore-ie8.jpg' style='border: none;' alt='Get Internet Explorer 8'/></a></div>
- <div style='width: 73px; float: left;'><a href='http://www.apple.com/safari/download/' target='_blank'><img src='http://www.ie6nomore.com/files/theme/ie6nomore-safari.jpg' style='border: none;' alt='Get Safari 4'/></a></div>
- <div style='float: left;'><a href='http://www.google.com/chrome' target='_blank'><img src='http://www.ie6nomore.com/files/theme/ie6nomore-chrome.jpg' style='border: none;' alt='Get Google Chrome'/></a></div>
- </div>
-</div>
-<![endif]-->
-
-
-<script type="text/javascript">
- var _gaq = _gaq || [];
- _gaq.push(['_setAccount', 'UA-50555-6']);
- _gaq.push(['_trackPageview']);
- (function() {
- var ga = document.createElement('script');
- ga.src = ('https:' == document.location.protocol ? 'https://ssl' :
- 'http://www') + '.google-analytics.com/ga.js';
- ga.setAttribute('async', 'true');
- document.documentElement.firstChild.appendChild(ga);
- })();
-</script>
-</body>
-</html>
-
-
diff --git a/docs/artistic.txt b/docs/artistic.txt
new file mode 100644
index 0000000..c04639a
--- /dev/null
+++ b/docs/artistic.txt
@@ -0,0 +1,127 @@
+The "Artistic License"
+
+ Preamble
+
+The intent of this document is to state the conditions under which a
+Package may be copied, such that the Copyright Holder maintains some
+semblance of artistic control over the development of the package,
+while giving the users of the package the right to use and distribute
+the Package in a more-or-less customary fashion, plus the right to make
+reasonable modifications.
+
+Definitions:
+
+ "Package" refers to the collection of files distributed by the
+ Copyright Holder, and derivatives of that collection of files
+ created through textual modification.
+
+ "Standard Version" refers to such a Package if it has not been
+ modified, or has been modified in accordance with the wishes
+ of the Copyright Holder as specified below.
+
+ "Copyright Holder" is whoever is named in the copyright or
+ copyrights for the package.
+
+ "You" is you, if you're thinking about copying or distributing
+ this Package.
+
+ "Reasonable copying fee" is whatever you can justify on the
+ basis of media cost, duplication charges, time of people involved,
+ and so on. (You will not be required to justify it to the
+ Copyright Holder, but only to the computing community at large
+ as a market that must bear the fee.)
+
+ "Freely Available" means that no fee is charged for the item
+ itself, though there may be fees involved in handling the item.
+ It also means that recipients of the item may redistribute it
+ under the same conditions they received it.
+
+1. You may make and give away verbatim copies of the source form of the
+Standard Version of this Package without restriction, provided that you
+duplicate all of the original copyright notices and associated disclaimers.
+
+2. You may apply bug fixes, portability fixes and other modifications
+derived from the Public Domain or from the Copyright Holder. A Package
+modified in such a way shall still be considered the Standard Version.
+
+3. You may otherwise modify your copy of this Package in any way, provided
+that you insert a prominent notice in each changed file stating how and
+when you changed that file, and provided that you do at least ONE of the
+following:
+
+ a) place your modifications in the Public Domain or otherwise make them
+ Freely Available, such as by posting said modifications to Usenet or
+ an equivalent medium, or placing the modifications on a major archive
+ site such as uunet.uu.net, or by allowing the Copyright Holder to include
+ your modifications in the Standard Version of the Package.
+
+ b) use the modified Package only within your corporation or organization.
+
+ c) rename any non-standard executables so the names do not conflict
+ with standard executables, which must also be provided, and provide
+ a separate manual page for each non-standard executable that clearly
+ documents how it differs from the Standard Version.
+
+ d) make other distribution arrangements with the Copyright Holder.
+
+4. You may distribute the programs of this Package in object code or
+executable form, provided that you do at least ONE of the following:
+
+ a) distribute a Standard Version of the executables and library files,
+ together with instructions (in the manual page or equivalent) on where
+ to get the Standard Version.
+
+ b) accompany the distribution with the machine-readable source of
+ the Package with your modifications.
+
+ c) give non-standard executables non-standard names, and clearly
+ document the differences in manual pages (or equivalent), together
+ with instructions on where to get the Standard Version.
+
+ d) make other distribution arrangements with the Copyright Holder.
+
+5. You may charge a reasonable copying fee for any distribution of this
+Package. You may charge any fee you choose for support of this
+Package. You may not charge a fee for this Package itself. However,
+you may distribute this Package in aggregate with other (possibly
+commercial) programs as part of a larger (possibly commercial) software
+distribution provided that you do not advertise this Package as a
+product of your own. You may embed this Package's interpreter within
+an executable of yours (by linking); this shall be construed as a mere
+form of aggregation, provided that the complete Standard Version of the
+interpreter is so embedded.
+
+6. The scripts and library files supplied as input to or produced as
+output from the programs of this Package do not automatically fall
+under the copyright of this Package, but belong to whoever generated
+them, and may be sold commercially, and may be aggregated with this
+Package. If such scripts or library files are aggregated with this
+Package via the so-called "undump" or "unexec" methods of producing a
+binary executable image, then distribution of such an image shall
+neither be construed as a distribution of this Package nor shall it
+fall under the restrictions of Paragraphs 3 and 4, provided that you do
+not represent such an executable image as a Standard Version of this
+Package.
+
+7. C subroutines (or comparably compiled subroutines in other
+languages) supplied by you and linked into this Package in order to
+emulate subroutines and variables of the language defined by this
+Package shall not be considered part of this Package, but are the
+equivalent of input as in Paragraph 6, provided these subroutines do
+not change the language in any way that would cause it to fail the
+regression tests for the language.
+
+8. Aggregation of this Package with a commercial distribution is always
+permitted provided that the use of this Package is embedded; that is,
+when no overt attempt is made to make this Package's interfaces visible
+to the end user of the commercial distribution. Such use shall not be
+construed as a distribution of this Package.
+
+9. The name of the Copyright Holder may not be used to endorse or promote
+products derived from this software without specific prior written permission.
+
+10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+
+ The End