Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move README.textile to README.md and add license header
The version of textile implemented by GitHub doesn't appear to support a comment syntax.
- Loading branch information
Showing
2 changed files
with
69 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
<!-- | ||
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. | ||
--> | ||
|
||
# Welcome to Apache Flume! | ||
|
||
Apache Flume is a distributed, reliable, and available service for efficiently | ||
collecting, aggregating, and moving large amounts of log data. It has a simple | ||
and flexible architecture based on streaming data flows. It is robust and fault | ||
tolerant with tunable reliability mechanisms and many failover and recovery | ||
mechanisms. The system is centrally managed and allows for intelligent dynamic | ||
management. It uses a simple extensible data model that allows for online | ||
analytic application. | ||
|
||
The Apache Flume 1.x (NG) code line is a refactoring of the first generation | ||
Flume to solve certain known issues and limitations of the original design. | ||
|
||
Apache Flume is open-sourced under the Apache Software Foundation License v2.0. | ||
|
||
## Documentation | ||
|
||
Documentation is included in the binary distribution under the docs directory. | ||
In source form, it can be found in the flume-ng-doc directory. | ||
|
||
The Flume 1.x guide and FAQ are available here: | ||
|
||
* https://cwiki.apache.org/FLUME/flume-ng.html | ||
* https://cwiki.apache.org/confluence/display/FLUME/Getting+Started | ||
|
||
## Contact us! | ||
|
||
* Mailing lists: https://cwiki.apache.org/confluence/display/FLUME/Mailing+Lists | ||
* IRC channel #flume on irc.freenode.net | ||
|
||
Bug and Issue tracker. | ||
|
||
* https://issues.apache.org/jira/browse/FLUME | ||
|
||
## Compiling Flume | ||
|
||
Compiling Flume requires the following tools: | ||
|
||
* Oracle Java JDK 1.7 | ||
* Apache Maven 3.x | ||
|
||
Note: The Apache Flume build requires more memory than the default configuration. | ||
We recommend you set the following Maven options: | ||
|
||
export MAVEN_OPTS="-Xms512m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=512m" | ||
|
||
To compile Flume, run `mvn compile`. | ||
To build a distribution, run `mvn install`. | ||
|
||
The final Flume distribution artifacts will be in $project/flume-ng-dist/target/. |
This file was deleted.
Oops, something went wrong.