Read Me
The Junicon Transformational Interpreter
----------------------------------------
Junicon is a Java-based interpreter for the Unicon programming language,
implemented using program transformation.
Documentation
-------------
Documentation can be found at junicon.sourceforge.net or unicon.org/junicon.
The list of changes can be found in the Release Notes.
System Requirements
-------------------
Java: SE 8 or above. JRE (Java Runtime Environment) to run Junicon.
JDK (Java Development Kit) if compiling Junicon programs
or building Junicon from source.
Maven: 3.0 or above (if building from source).
Operating System:
On Linux/MacOS, csh is required to run the executables.
On Windows, if using csh and not exe, Cygwin or the equivalent is required.
Installing Junicon
------------------
1) Download junicon for Linux/MacOS, or junicon.exe for Windows.
All dependencies are already in the distribution, including Groovy.
2) Download and install the current version of the Java runtime.
3) Make sure java or java.exe is in your path, or set JAVA_HOME to
the location of your Java installation.
4) Optionally, add the junicon executable to your PATH:
Linux/MacOS/Cygwin: export PATH=yourDirectory/junicon:$PATH
Windows: set PATH="yourDirectory/junicon.exe";%PATH%
5) Run "junicon -h" to see the program options.
Building Junicon
----------------
1) Download a snapshot of the source, and unzip it.
2) Download and install the current version of the Java JDK.
3) Download and install the current version of Maven.
4) Set M2_HOME to the location of Maven.
Also set JAVA_HOME to the location of your Java JDK installation.
5) Run bin/build or bin/build.bat to build Junicon.
6) Type "clean install site" at the prompt, or just hit enter.
7) Move junicon or junicon.exe from distribution/target/ to your desired
installation directory, and proceed as above under "Installing Junicon".
Licensing
---------
Junicon is provided under the Simplified BSD License.
#=============================================================================
# LICENSE and COPYRIGHT
#=============================================================================
Copyright (c) 2015 Orielle, LLC.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
This software is provided by the copyright holders and contributors
"as is" and any express or implied warranties, including, but not
limited to, the implied warranties of merchantability and fitness for
a particular purpose are disclaimed. In no event shall the copyright
holder or contributors be liable for any direct, indirect, incidental,
special, exemplary, or consequential damages (including, but not
limited to, procurement of substitute goods or services; loss of use,
data, or profits; or business interruption) however caused and on any
theory of liability, whether in contract, strict liability, or tort
(including negligence or otherwise) arising in any way out of the use
of this software, even if advised of the possibility of such damage.
#=============================================================================
# NOTICES
#=============================================================================
Portions of this software were jointly developed with the University of Idaho.
This product includes software developed by the
Apache Software Foundation (http://www.apache.org/).
This product includes software developed by the
Spring Framework Project (http://www.springsource.org).
This product includes software developed by the
Groovy community (http://groovy.codehaus.org/).
#==== END OF FILE