apex-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From david...@apache.org
Subject incubator-apex-malhar git commit: Cleanup README.md
Date Mon, 05 Oct 2015 17:14:15 GMT
Repository: incubator-apex-malhar
Updated Branches:
  refs/heads/devel-3 2918f2f88 -> affcc5e54


Cleanup README.md


Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/commit/affcc5e5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/tree/affcc5e5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/diff/affcc5e5

Branch: refs/heads/devel-3
Commit: affcc5e54b50cc51a3bbdf6a1b77ceb8f6e8ceeb
Parents: 2918f2f
Author: MalharJenkins <jenkins@datatorrent.com>
Authored: Mon Oct 5 10:06:34 2015 -0700
Committer: Thomas Weise <thomas@datatorrent.com>
Committed: Mon Oct 5 10:06:53 2015 -0700

----------------------------------------------------------------------
 README.md | 82 ++++++++++++++--------------------------------------------
 1 file changed, 19 insertions(+), 63 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/affcc5e5/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 58acfad..df926a6 100644
--- a/README.md
+++ b/README.md
@@ -1,95 +1,51 @@
-Malhar
-======
-Malhar repository contains open source operator and codec library that can be used with the
DataTorrent platform to build Realtime streaming applications. In addition to the library
there are benchmark, contrib, demos, webdemos and samples folders available. Demos contain
demo applications built using the library operators. Webdemos contain webpages for the demos.
Benchmark contains performance testing applications. Contrib contains additional operators
that interface with third party softwares. Samples contain some sample code that shows how
to use the library operators.
+Apache Apex Malhar (incubating)
+===============================
 
+Malhar repository contains open source operator and codec library that can be used with the
Apache Apex (incubating) platform to build Realtime streaming applications. In addition to
the library there are benchmark, contrib, demos, webdemos and samples folders available. Demos
contain demo applications built using the library operators. Webdemos contain webpages for
the demos. Benchmark contains performance testing applications. Contrib contains additional
operators that interface with third party softwares. Samples contain some sample code that
shows how to use the library operators.
 
 Contributing
 ------------
 
 This project welcomes new contributors.  If you would like to help make Malhar better by
adding new features, enhancing existing features, or fixing bugs, here is how to do it.
 
-You acknowledge that your submissions to DataTorrent on this repository are made pursuant
the terms of the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html)
and constitute "Contributions," as defined therein, and you represent and warrant that you
have the right and authority to do so.
+You acknowledge that your submissions on this repository are made pursuant the terms of the
Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html) and constitute
"Contributions," as defined therein, and you represent and warrant that you have the right
and authority to do so.
 
   * Fork Malhar into your own GitHub repository
   * Create a topic branch with an appropriate name
   * Write code, comments, tests in your repository
   * Create a GitHub pull request from your repository, providing as many details about your
changes as possible
-  * After we review and accept your request we’ll commit your code to the DataTorrent/Malhar
repository
+  * After we review and accept your request we’ll commit your code to the repository
 
 The submitted code must follow certain prescribed conventions and it is also recommended
that it follow the prescribed style. The conventions and style are described in the [Coding
Conventions and Style](docs/CodingConventionsAndStyle.md) document.
 
-When adding **new files**, please include the following Apache v2.0 license header at the
top of the file, with the fields enclosed by brackets "[]" replaced with your own identifying
information. **(Don't include the brackets!)**:
-
-    /*
-     * Copyright (c) [XXXX] [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.
-     */
+When adding **new files**, please include the Apache v2.0 license header. From the top level
directory:
 
-Thanks for contributing!
+Run `mvn license:check -Dlicense.skip=false` to check correct header formatting.
+Run `mvn license:format -Dlicense.skip=false` to automatically add the header when missing.
 
+Thanks for contributing!
 
 Documentation
 -------------
 
-The documentation for Operators, Widgets, Demos, and Apps is available at [Malhar Javadocs](https://datatorrent.com/docs/apidocs/).
Documentation
-for the platform itself can be found at [Resources](https://datatorrent.com/resources.php).
+Please visit the [documentation section](http://apex.incubator.apache.org/docs.html).
 
 Discussion group
 --------------------
 
-Please use the [Malhar discussion group](http://groups.google.com/group/malhar-users) for
support. Subscription to the group is open and postings are welcome. You can post anything
about the operators, discuss new operator ideas or report issues and get answers from experts.
You can signup by going to the following url https://groups.google.com/forum/#!forum/malhar-users
-
-
-Getting the source code
-------------------------
-
-The Malhar repository is on github.com. You can download or clone it using the GitHub links.
 If you already have a GitHub account you can fork the DataTorrent/Malhar repository and contribute
with pull requests.  See Contributing section below.
-
-
-Compiling the code
-----------------------
-
-The project uses maven to build the code. To build the code run mvn install at the top level.
The code also has a dependency to the DataTorrent API. The API releases are available in the
DataTorrent maven repository and the Malhar pom.xml is configured with it. Individual modules
such as library can be built independently by changing directory to the module and running
maven there.
+Please visit http://apex.incubator.apache.org and [subscribe](http://apex.incubator.apache.org/community.html)
to the mailing lists.
 
-Running the code
--------------------
-
-To run the code DataTorrent platform is needed. The developer version or an evaluation version,
both of which are free, can be downloaded from 
-
-https://www.datatorrent.com/download/
-
-Please follow the instructions in the software README on how to run the application.  
-
-For an easer setup, sandbox virtual machine provides pre-configured DataTorrent platform
with all necessary dependencies, and can be found in the download section.
-
-
-Demos
--------------------
-
-Multiple demos are provided with the DataTorrent platform to showcase the platform and provide
application development examples.  Demos can be executed after downloading and installing
DataTorrent platform or the sandbox with pre-configured DataTorrent platform environment.
 See [demos source code](https://github.com/DataTorrent/Malhar/tree/master/demos/src/main/java/com/datatorrent/demos)
for application development examples.
+Building the project
+--------------------
 
-Web Apps
--------------------
+The project uses Maven for the build. Run
+```
+mvn install
+```
 
-Web interface for the following demos is available:
-- Twitter
-- Mobile
-- Machine Generated Data
-- Ads Dimensions
-- Fraud
+The code depends on the Apex API. The API releases are available in the DataTorrent maven
repository and the Malhar pom.xml is configured with it. Individual modules such as library
can be built independently by changing directory to the module and running maven there.
 
-Web apps run on Node.js. Please see [webapps](https://github.com/DataTorrent/Malhar/tree/master/webapps)
for more information.
+Multiple [demo applications](demos/src/main/java/com/datatorrent/demos) are provided to showcase
the Apex platform and application development process. 
 
 Issue tracking
 --------------------


Mime
View raw message