Skip to content

Commit

Permalink
Add VERSION file, update build scripts and P3LX.VERSION
Browse files Browse the repository at this point in the history
  • Loading branch information
mcslee committed Aug 15, 2018
1 parent d8a269e commit 7296296
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 54 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
P3LX
====

**BY DOWNLOADING OR USING THE LX SOFTWARE OR ANY PART THEREOF, YOU AGREE TO THE TERMS AND CONDITIONS OF THE [LX STUDIO SOFTWARE LICENSE AND DISTRIBUTION AGREEMENT](http://lx.studio/license).**

Please note that LX is not open-source software. The license grants permission to use this software freely in non-commercial applications. Commercial use is subject to a total annual revenue limit of $25K on any and all projects associated with the software. If this licensing is obstructive to your needs or you are unclear as to whether your desired use case is compliant, contact me to discuss proprietary licensing: [email protected]

---

### Overview ###
### P3LX Overview ###

P3LX is a Processing 3 wrapper library for the [LX](https://github.com/heronarts/LX) lighting engine and the basis of the [LX Studio](http://lx.studio/) application. It allows you to simply embed LX inside a Processing sketch with a rich UI library that makes it easy and painless to render 3D simulations alongside versatile 2D controls.

Expand All @@ -23,17 +20,10 @@ $ git clone https://github.com/heronarts/LX.git
$ git clone https://github.com/heronarts/P3LX.git
```

To build the full project:
To build the project:
```
$ cd P3LX/build
$ ant
```

For quicker build during iterative development, there is a lightweight build task included which does no preprocessing, documentation generation, etc. Note that this task also does no cleanup. If you've removed or renamed files, you'll want to manually nuke the `bin` folder to avoid issues.

```
$ cd P3LX/build
$ ant lightning
$ cp ../bin/P3LX.jar <wherever you need it>
```

Expand Down
7 changes: 7 additions & 0 deletions VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
0.1.1
August 15, 2018
Dropping alpha tag, updating release packaging with VERSION and LICENSE files.

0.1.0-alpha
August 13, 2018
Initial release cut for tracking versioned changes across the LX repositories.
13 changes: 0 additions & 13 deletions build/build.properties
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,6 @@ java.target.version=1.8

project.name=P3LX


# Use 'normal' or 'fast' as value for project.compile.
# 'fast' will only compile the project into your sketchbook.
# 'normal' will compile the distribution including the javadoc-reference and all
# web-files (the compile process here takes longer).

project.compile=fast

# All files compiled with project.compile=normal are stored
# in the distribution folder.



# (5)
# The following items are properties that will be used to make changes to the
# web document templates. Values of properties will be inserted into the
Expand Down
47 changes: 21 additions & 26 deletions build/build.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<project name="P3LX" default="clean" basedir="../">
<project name="P3LX" default="jar" basedir="../">

<property file="./build/build.properties" />

Expand All @@ -8,10 +8,6 @@

<property name="line" value="------------------------------------------------------------------------------------------------" />

<condition property="is.normal">
<equals arg1="${project.compile}" arg2="normal" />
</condition>

<!-- set the OS properties -->
<condition property="is.mac">
<os family="mac" />
Expand Down Expand Up @@ -73,8 +69,8 @@ ${line}
<antcall target="generate.structure">
<param name="folder" value="library" />
</antcall>
<antcall target="jar" />
<antcall target="generate.source" />
<antcall target="compile" />
<antcall target="generate.jar">
<param name="folder" value="library" />
</antcall>
Expand All @@ -88,7 +84,7 @@ ${line}
<delete dir="${project.tmp}" />
</target>

<target name="generate.libprops" if="is.normal">
<target name="generate.libprops">
<property name="libprops.destination" location="${project.tmp}/${project.name}/library.properties" />
<copy file="${libprops.source}" tofile="${libprops.destination}" />
<antcall target="parse.file">
Expand All @@ -114,15 +110,12 @@ ${line}
<compilerarg value="-Xlint" />
</javac>
<copy todir="${project.bin.data}">
<fileset dir="${project.data}" excludes="README" />
<fileset dir="${project.data}" />
</copy>
</target>

<target name="generate.jar">
<jar jarfile="${project.tmp}/${project.name}/${folder}/${project.jar.name}" basedir="${project.bin}">
<zipgroupfileset dir="${project.lib}" includes="coremidi4j-0.9.jar" />
<zipgroupfileset dir="${project.lib}" includes="gson-2.8.0.jar" />
</jar>
<target name="generate.jar" depends="jar">
<copy file="${project.bin}/${project.jar.name}" todir="${project.tmp}/${project.name}/${folder}" />
</target>

<target name="generate.structure">
Expand All @@ -141,7 +134,7 @@ ${line}
</copy>
</target>

<target name="generate.source" if="is.normal">
<target name="generate.source">
<antcall target="generate.source.win" />
<antcall target="generate.source.nix" />
</target>
Expand All @@ -164,17 +157,17 @@ ${line}
<foreach list="${src.list}" param="file" target="parse.file" delimiter=":" />
</target>

<target name="generate.distribution" if="is.normal">
<target name="generate.distribution">
<mkdir dir="${project.dist}" />
<delete dir="${project.dist.version}" />
<mkdir dir="${project.dist.version}" />
<mkdir dir="${project.dist.version}/${project.name}" />
<move file="${project.tmp}/${project.name}" toDir="${project.dist.version}" />
</target>

<target name="generate.javadoc" if="is.normal">
<target name="generate.javadoc">
<!-- create the java reference of the library -->
<javadoc bottom="Processing library ${project.name} by ${author.name}. ${library.copyright}" classpath="${classpath.local.location}/video.jar;${classpath.local.location}/core.jar;${classpath.local.location}/jogl-all.jar;${project.lib}/gson-2.8.0.jar;{project.bin}" destdir="${project.tmp}/${project.name}/reference" verbose="false" stylesheetfile="build/stylesheet.css" doctitle="${project.name} API Specification" version="false" windowtitle="${project.name} API">
<javadoc bottom="Processing library ${project.name} by ${author.name}. ${library.copyright}" classpath="${classpath.local.location}/video.jar;${classpath.local.location}/core.jar;${classpath.local.location}/jogl-all.jar;${project.lib}/coremidi4j-0.9.jar;${project.lib}/gson-2.8.0.jar;{project.bin}" destdir="${project.tmp}/${project.name}/reference" verbose="false" stylesheetfile="build/stylesheet.css" doctitle="${project.name} API Specification" version="false" windowtitle="${project.name} API">

<link href="${javadoc.java.href}" />
<link href="${javadoc.processing.href}" />
Expand Down Expand Up @@ -218,7 +211,7 @@ ${line}
<replaceregexp file="${file}" match="##tested.processingVersion##" replace="${tested.processingVersion}" flags="g" />
</target>

<target name="generate.zip" if="is.normal">
<target name="generate.zip">
<!-- zip the distribution of the library -->
<move todir="${project.dist.version}/tmp/${project.name}-${library.version}">
<fileset dir="${project.dist.version}/${project.name}" />
Expand All @@ -229,7 +222,7 @@ ${line}
<delete dir="${project.dist.version}/tmp" />
</target>

<target name="lightning">
<target name="jar">
<delete file="${project.bin}/${project.jar.name}" />
<mkdir dir="${project.bin}" />
<javac destdir="${project.bin}" source="${java.target.version}" target="${java.target.version}" includeantruntime="false">
Expand All @@ -240,30 +233,32 @@ ${line}
</classpath>
<compilerarg value="-Xlint" />
</javac>
<copy todir="${project.bin.data}">
<fileset dir="${project.data}" />
</copy>
<jar jarfile="${project.bin}/${project.jar.name}" basedir="${project.bin}">
<fileset dir="${basedir}" includes="LICENSE VERSION data/**" />
<zipgroupfileset dir="${project.lib}" includes="coremidi4j-0.9.jar" />
<zipgroupfileset dir="${project.lib}" includes="gson-2.8.0.jar" />
</jar>
</target>

<target name="clean" depends="library.run">
<delete dir="${project.bin}" />
<delete dir="${project.tmp}" />
<target name="library">
<antcall target="clean" />
<antcall target="library.run" />
<echo>

${line}
Name ${project.name}
Version ${library.prettyVersion} (${library.version})
Compiled ${project.compile}
Sketchbook ${sketchbook.location}
${line}
done, finished.
${line}
</echo>
</target>

<target name="clean">
<delete dir="${project.bin}" />
<delete dir="${project.tmp}" />
</target>

</project>

4 changes: 1 addition & 3 deletions src/heronarts/p3lx/P3LX.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@
*/
public class P3LX extends LX {

public final static String VERSION = "##library.prettyVersion##";

public static boolean isProcessing2X = false;
public final static String VERSION = LX.VERSION;

/**
* Returns the version of the library.
Expand Down

0 comments on commit 7296296

Please sign in to comment.