You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@etch.apache.org by sc...@apache.org on 2009/04/24 16:02:23 UTC
svn commit: r768314 - in /incubator/etch/trunk: BUILD.txt DISCLAIMER.txt
README.txt
Author: sccomer
Date: Fri Apr 24 14:02:23 2009
New Revision: 768314
URL: http://svn.apache.org/viewvc?rev=768314&view=rev
Log:
fix linebreaks and remove bogus license header.
fix README.txt and augment.
Modified:
incubator/etch/trunk/BUILD.txt
incubator/etch/trunk/DISCLAIMER.txt
incubator/etch/trunk/README.txt
Modified: incubator/etch/trunk/BUILD.txt
URL: http://svn.apache.org/viewvc/incubator/etch/trunk/BUILD.txt?rev=768314&r1=768313&r2=768314&view=diff
==============================================================================
--- incubator/etch/trunk/BUILD.txt (original)
+++ incubator/etch/trunk/BUILD.txt Fri Apr 24 14:02:23 2009
@@ -1,21 +1,3 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one *
- * or more contributor license agreements. See the NOTICE file *
- * distributed with this work for additional information *
- * regarding copyright ownership. The ASF licenses this file *
- * to you 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. *
-*/
Build Instructions for Apache Etch
==================================
Modified: incubator/etch/trunk/DISCLAIMER.txt
URL: http://svn.apache.org/viewvc/incubator/etch/trunk/DISCLAIMER.txt?rev=768314&r1=768313&r2=768314&view=diff
==============================================================================
--- incubator/etch/trunk/DISCLAIMER.txt (original)
+++ incubator/etch/trunk/DISCLAIMER.txt Fri Apr 24 14:02:23 2009
@@ -1,5 +1,10 @@
-Apache Etch is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC.
+Apache Etch is an effort undergoing incubation at the Apache Software
+Foundation (ASF), sponsored by the Apache Incubator PMC.
-Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects.
+Incubation is required of all newly accepted projects until a further review
+indicates that the infrastructure, communications, and decision making process
+have stabilized in a manner consistent with other successful ASF projects.
-While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+While incubation status is not necessarily a reflection of the completeness or
+stability of the code, it does indicate that the project has yet to be fully
+endorsed by the ASF.
Modified: incubator/etch/trunk/README.txt
URL: http://svn.apache.org/viewvc/incubator/etch/trunk/README.txt?rev=768314&r1=768313&r2=768314&view=diff
==============================================================================
--- incubator/etch/trunk/README.txt (original)
+++ incubator/etch/trunk/README.txt Fri Apr 24 14:02:23 2009
@@ -1,27 +1,29 @@
-Welcome to the 1.0.2-incubating release of Apache Etch.
+Welcome to the 1.1.0-incubating release of Apache Etch.
= What is Etch? =
-Etch is a cross-platform, language- and transport-independent framework for building
-and consuming network services. The Etch toolset includes a network service description
-language, a compiler, and binding libraries for a variety of programming languages. Etch
-is also transport-independent, allowing for a variety of different transports to used
-based on need and circumstance. The goal of Etch is to make it simple to define small,
-focused services that can be easily accessed, combined, and deployed in a similar
-manner. With Etch, service development and consumption becomes no more difficult than
-library development and consumption.
+Etch is a cross-platform, language- and transport-independent framework for
+building and consuming network services. The Etch toolset includes a network
+service description language, a compiler, and binding libraries for a variety
+of programming languages. Etch is also transport-independent, allowing for a
+variety of different transports to used based on need and circumstance. The
+goal of Etch is to make it simple to define small, focused services that can
+be easily accessed, combined, and deployed in a similar manner. With Etch,
+service development and consumption becomes no more difficult than library
+development and consumption.
= Online Help =
The jumping off point for Etch information and help is here:
-http://cwiki.apache.org/ETCH
+ http://cwiki.apache.org/ETCH
= Binary Distribution =
The top-level structure of the install image is:
ChangeLog.txt
+ DISCLAIMER.txt
LICENSE.txt
NOTICE.txt
README.txt
@@ -30,83 +32,108 @@
examples/
lib/
maven/
- uninst.exe (windows only)
+ uninst.exe (for windows use only)
Please take a moment to review the RELEASE_NOTES.txt, ChangeLog.txt and
LICENSE.txt files.
-The Windows installer (apache-etch-1.0.2-incubating-setup.exe) has created a
+The Windows installer (apache-etch-1.1.0-incubating-setup.exe) has created a
user environment variable (ETCH_HOME) which points to the Etch installation
-directory. If you installed Etch using either apache-etch-1.0.2-incubating-bin.tar.gz
-or apache-etch-1.0.2-incubating-bin.zip, you will want to create this environment
-variable yourself:
+directory. If you installed Etch using either
+
+ apache-etch-1.1.0-incubating-bin.tar.gz
+
+or
+
+ apache-etch-1.1.0-incubating-bin.zip
+
+you will want to create this environment variable yourself:
windows:
- set ETCH_HOME=C:\Program Files\Apache Software Foundation\apache-etch-1.0.2
+ set ETCH_HOME=C:\Program Files\Apache Software Foundation\apache-etch-1.1.0
*nix:
- export ETCH_HOME=/path/to/apache-etch-1.0.2
+ export ETCH_HOME=/path/to/apache-etch-1.1.0
The bin directory has also been put on your path by the Windows installer. If
you are using the archives, you will need to do this yourself:
windows:
- PATH %PATH%;%ETCH_HOME%\bin
+ PATH %PATH%;%ETCH_HOME%\bin
*nix:
- export PATH="$PATH:$ETCH_HOME/bin"
+ export PATH="$PATH:$ETCH_HOME/bin"
The bin/ directory contains a Windows bat script and a unix shell script.
-You will also need to have a java sdk installed (later versions of 1.5 or
-any version of 1.6). A JAVA_HOME environment variable should point to the
-installation directory of the java sdk.
-
-In the end, at a command line or shell, you should be able to run the etch
-compiler and see some basic output:
+You will also need to have a java runtime installed (later versions of sun jre
+or jdk 1.5 or any version of 1.6 or later). A JAVA_HOME environment variable
+should point to the installation directory of the java runtime. If you are going
+to compile java source you will need the jdk.
+
+After the installer has been run and the environment setup, at a windows
+command line or shell prompt, you should be able to run the etch compiler and
+see some basic output:
windows:
- C:\>etch
- etch: option '-b binding' must be specified on the command line
+ C:\>etch -v
+ Etch version is Apache Etch 1.1.0-incubating (some build info)
unix:
- bash-3.2$ etch
- etch: option '-b binding' must be specified on the command line
+ bash-3.2$ etch -v
+ Etch version is Apache Etch 1.1.0-incubating (some build info)
+
+The lib directory contains the various jar files, zipped sources, and a C# dll
+with associated symbols:
-The lib directory contains the various jar files, zipped sources, and a C# dll:
+ Etch.dll
+ Etch.pdb
+ ...
+ etch-java-runtime-1.1.0-src.zip
+ etch-java-runtime-1.1.0.jar
+ ...
- Etch.dll
- etch-ant-plugin-1.0.2-src.zip
- etch-ant-plugin-1.0.2.jar
- etch-java-runtime-1.0.2-src.zip
- etch-java-runtime-1.0.2.jar
- ...
+The main items of interest, shown above, are the language binding runtimes,
+which you need to link with your projects.
-The main items of interest are the language binding runtimes, which you need to
-link with your projects.
+For java you need to put the etch java runtime jar on the classpath of your
+projects:
-For java you need to put on the classpath of your projects: etch-java-runtime-1.0.2.jar.
-There is source code to go with it in etch-java-runtime-1.0.2-src.zip.
+ etch-java-runtime-1.1.0.jar
-The C# (.NET 2.0) Etch.dll should be added to any C# projects.
+There is source code to go with it in etch-java-runtime-1.1.0-src.zip.
+
+The C# (.NET 2.0 and later) Etch.dll should be added to any C# projects.
There is an ant plugin which you can use with ant 1.7.0 or later to invoke the
compiler as a task. It is documented on the wiki referenced above.
+= Maven =
+
If you are using maven, then you might want to install the Etch artifacts into
your local maven repository. There is a Windows bat script to do this in the
maven directory:
- etch-maven-install.bat
+ etch-maven-install.bat
You need to have maven on your path when you run this script. The file
-etch-java-runtime-1.0.2.jar will be installed into your local repository with
-group "etch.etch", artifact id "etch-java-runtime", and version "1.0.2". You
+etch-java-runtime-1.1.0.jar will be installed into your local repository with
+group "etch.etch", artifact id "etch-java-runtime", and version "1.1.0". You
may then reference Etch from your maven projects.
-Examples have been provided in the examples/ subdirectory.
+= Examples =
+
+Examples have been provided in the examples/ subdirectory. There is a readme
+file in each example's directory which explains how to build and run it.
+
+= Tests =
+
+Unit tests can be had by checking out the source code from the subversion
+repository and performing a complete build:
+
+ https://svn.apache.org/repos/asf/incubator/etch/releases/release-1.1.0
-Unit tests can be had by checking out the source code from the
-subversion repository and performing a complete build:
+= Help =
- https://svn.apache.org/repos/asf/incubator/etch/releases/release-1.0.2
+For help, see the wiki or send email to etch-user@incubator.apache.org. See
+RELEASE_NOTES.txt for specific information for this release.