Skip to content

Commit

Permalink
more tweaking of the scripts and notice files for the pixel bender pa…
Browse files Browse the repository at this point in the history 
…ckage
  • Loading branch information
@aharui
aharui committed Dec 21, 2013
1 parent 19b592d commit c3b7791
Show file tree
Hide file tree
Showing 5 changed files with 388 additions and 87 deletions.
203 changes: 203 additions & 0 deletions LICENSE.pb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

9 changes: 9 additions & 0 deletions NOTICE.pb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Apache Flex
Copyright 2013 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).

The Initial Developer of the Original Code, known as Adobe Flex,
is Adobe Systems Incorporated (http://www.adobe.com/).
Copyright 2003 - 2012 Adobe Systems Incorporated. All Rights Reserved.
83 changes: 43 additions & 40 deletions README.pb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,20 @@ Apache Flex (Flex)
For detailed information about Apache Flex please visit
http://flex.apache.org/

The PixelBender package contains PixelBender shaders used by the Apache Flex SDK.
The Apache Flex Pixel Bender package contains Pixel Bender shaders used by the
Apache Flex SDK.

To build the pbj files, run the build-pixelbender target in build.xml.
To compile the Pixel Bender shaders, run:

While Apache Flex runs on a large set of platforms, the PixelBender compiler
is only supported on:
ant -f pixelbender.xml.

While Apache Flex runs on a large set of platforms, the Adobe Pixel Bender
compiler used to compile the shaders is only supported on:

Microsoft Windows
Mac OS X

Getting the convenience packages for Apache Flex
Getting the convenience packages for the Apache Flex Pixel Bender shaders.
================================================

You can also get just the binaries from our website. These binaries do not
Expand All @@ -41,37 +44,27 @@ Getting the latest sources via git
cd sdk
git checkout develop

An Apache Flex SDK also requires source code from other Apache Flex git
repositories. To get the latest source via git for the Text Layout Framework
use the following command:

git clone https://git-wip-us.apache.org/repos/asf/flex-tlf.git tlf
cd tlf
git checkout develop

In an Apache Flex source code package hosted on the distribution server or
one of its mirrors, the Text Layout Framework code is already included in
the package. This is also true for the convenience package.
The above sequence actually checks out the entire Apache Flex SDK. The
Pixel Bender files are a subset of files from this repository.

For further information visit http://flex.apache.org/download-source.html

Building Apache Flex PixelBender Files
Building Apache Flex Pixel Bender Files
=========================

Apache Flex PixelBender files requires a build tools which must be installed
Apache Flex Pixel Bender files requires a build tool which must be installed
prior to building Flex. The build tools have a proprietary license.

Install Prerequisites
---------------------

Before building the PixelBender files you must install the following software and
Before building the Pixel Bender files you must install the following software and
set the corresponding environment variables using absolute file paths. Relative
file paths will result in build errors.

The environment variable PIXELBENDER_HOME can also be set in the property file
called env.properties. See the env-template.properties file for instructions.

The Adobe Pixel Bender Toolkit is needed to build these files.
The Adobe Pixel Bender Toolkit is needed to build these files. You may also
need to set the JAVA_HOME and ANT_HOME environment variables as described below.

==================================================================================
SOFTWARE ENVIRONMENT VARIABLE (absolute paths)
Expand All @@ -97,7 +90,7 @@ Install Prerequisites

export PATH="$PATH:$ANT_HOME/bin:$JAVA_HOME/bin"

On Linux make sure you path include ANT_HOME and JAVA_HOME.
There is no Pixel Bender compiler for Linux.

*2) If you are using Java SDK 1.7 or greater on a Mac you must use Ant 1.8 or
greater. If you use Java 1.7 with Ant 1.7, ant reports the java version as 1.6
Expand All @@ -113,37 +106,47 @@ Install Prerequisites

Download the Pixel Bender Toolkit for your platform and install or unzip it.
On Windows and Mac Set PIXELBENDER_HOME to the absolute path of the Pixel Bender
Toolkit directory, on Linux set it to be the absolute path of the compiled
Pixel Bender files.
Toolkit directory.


Using the Binary Distribution
-----------------------------

The binary distribution should be usable as-is and not require building.
It is meant to be expanded on top of an existing Flex SDK folder.
The binary distribution should be usable as-is and not require building. The
binary distribution is used in a build of the main Flex SDK build script. To
set the Flex SDK build to use a binary distribution, run the main Flex SDK
build.xml's main target and set -Dpixelbender.url=<path to folder containing
binary distribution> or set pixelbender.url in a local.properties file.


Building the Source in the Source Distribution
----------------------------------------------

To build the source, run:
ant build-pixelbender

The build script is the same script used by the Flex SDK and the default targets
are set up for the Flex SDK.
To clean the build, of everything other than the downloaded third-party dependencies
use
ant -f pixelbender.xml

To clean the build of the compiled PBJ files use:

ant clean
ant -f pixelbender.xml clean

To use the PBJ files in an Flex SDK build run:

ant -f pixelbender.xml copy-to-flex-sdk

The above will copy the PBJ files to the appropriate places in the folder
specified by the environment variable FLEX_HOME which may also be
specified on the command line or in a local.properties file as:

ant -f pixelbender.xml -DFLEX_HOME=<path to Flex SDK> copy-to-flex-sdk

The presence of the PBJ files in the Flex SDK folders will prevent the Flex
SDK from downloading a binary distribution to access those PBJ files.

To clean the build, of everything, including the downloaded third-party dependencies
use

ant super-clean (which is just thirdparty-clean followed by clean)

To generate a source distribution package and a binary distribution package use
Note for Release Managers: To generate a source distribution package and a
binary distribution package use the main Flex SDK build.xml as follows

ant -Dbuild.number=<YYYYMMDD> -Dbuild.noprompt= release-pixelbender
ant release-pixelbender

The packages can be found in the "out" subdirectory.

Expand Down
Loading

0 comments on commit c3b7791

Please sign in to comment.