You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by jo...@apache.org on 2014/02/14 04:45:23 UTC
git commit: KAFKA-1263 Snazzy up the README markdown for better
visibility on github; patched by Joe Stein; reviewed by Neha Narkhede
Updated Branches:
refs/heads/0.8.1 5023c2ff2 -> 879e3e770
KAFKA-1263 Snazzy up the README markdown for better visibility on github; patched by Joe Stein; reviewed by Neha Narkhede
Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/879e3e77
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/879e3e77
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/879e3e77
Branch: refs/heads/0.8.1
Commit: 879e3e770ebc49f916137e8416df74373fa26a74
Parents: 5023c2f
Author: Joe Stein <jo...@stealth.ly>
Authored: Thu Feb 13 22:45:07 2014 -0500
Committer: Joe Stein <jo...@stealth.ly>
Committed: Thu Feb 13 22:45:07 2014 -0500
----------------------------------------------------------------------
README.md | 112 ++++++++++++++++++++++++++++-----------------------------
1 file changed, 55 insertions(+), 57 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/kafka/blob/879e3e77/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index e3fea22..ec80083 100644
--- a/README.md
+++ b/README.md
@@ -1,80 +1,78 @@
-# 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.
-
-# Apache Kafka #
+Apache Kafka
+=================
See our [web site](http://kafka.apache.org) for details on the project.
-## Building a jar and running it ##
-1. ./gradlew jar
-2. Follow instuctions in http://kafka.apache.org/documentation.html#quickstart
+### Building a jar and running it ###
+ ./gradlew jar
-## Running unit tests ##
-./gradlew test
+Follow instuctions in http://kafka.apache.org/documentation.html#quickstart
-## Forcing re-running unit tests w/o code change ##
-./gradlew cleanTest test
+### Running unit tests ###
+ ./gradlew test
-## Running a particular unit test ##
-./gradlew -Dtest.single=RequestResponseSerializationTest core:test
+### Forcing re-running unit tests w/o code change ###
+ ./gradlew cleanTest test
+
+### Running a particular unit test ###
+ ./gradlew -Dtest.single=RequestResponseSerializationTest core:test
+
+### Building a binary release gzipped tar ball ###
+ ./gradlew clean
+ ./gradlew releaseTarGz
-## Building a binary release gzipped tar ball ##
-./gradlew clean
-./gradlew releaseTarGz
The release file can be found inside ./core/build/distributions/.
-## Cleaning the build ##
-./gradlew clean
+### Cleaning the build ###
+ ./gradlew clean
+
+### Running a task on a particular version of Scala ####
+either 2.8.0, 2.8.2, 2.9.1, 2.9.2 or 2.10.1) (If building a jar with a version other than 2.8.0, the scala version variable in bin/kafka-run-class.sh needs to be changed to run quick start.)
+ ./gradlew -PscalaVersion=2.9.1 jar
+ ./gradlew -PscalaVersion=2.9.1 test
+ ./gradlew -PscalaVersion=2.9.1 releaseTarGz
+
+### Running a task for a specific project ###
+This is for 'core', 'perf', 'contrib:hadoop-consumer', 'contrib:hadoop-producer', 'examples' and 'clients'
+ ./gradlew core:jar
+ ./gradlew core:test
-## Running a task on a particular version of Scala (either 2.8.0, 2.8.2, 2.9.1, 2.9.2 or 2.10.1) ##
-## (If building a jar with a version other than 2.8.0, the scala version variable in bin/kafka-run-class.sh needs to be changed to run quick start.) ##
-./gradlew -PscalaVersion=2.9.1 jar
-./gradlew -PscalaVersion=2.9.1 test
-./gradlew -PscalaVersion=2.9.1 releaseTarGz
+### Listing all gradle tasks ###
+ ./gradlew tasks
-## Running a task for a specific project in 'core', 'perf', 'contrib:hadoop-consumer', 'contrib:hadoop-producer', 'examples', 'clients' ##
-./gradlew core:jar
-./gradlew core:test
+### Building IDE project ####
+ ./gradlew eclipse
+ ./gradlew idea
-## Listing all gradle tasks ##
-./gradlew tasks
+### Building the jar for all scala versions and for all projects ###
+ ./gradlew jarAll
-# Building IDE project ##
-./gradlew eclipse
-./gradlew idea
+### Running unit tests for all scala versions and for all projects ###
+ ./gradlew testAll
-# Building the jar for all scala versions and for all projects ##
-./gradlew jarAll
+### Building a binary release gzipped tar ball for all scala versions ###
+ ./gradlew releaseTarGzAll
-## Running unit tests for all scala versions and for all projects ##
-./gradlew testAll
+### Publishing the jar for all version of Scala and for all projects to maven ###
+ ./gradlew uploadArchivesAll
-## Building a binary release gzipped tar ball for all scala versions ##
-./gradlew releaseTarGzAll
+Please note for this to work you need to create/update `~/.gradle/gradle.properties` and assign the following variables
-## Publishing the jar for all version of Scala and for all projects to maven (To test locally, change mavenUrl in gradle.properties to a local dir.) ##
-./gradlew uploadArchivesAll
+ mavenUrl=
+ mavenUsername=
+ mavenPassword=
+ signing.keyId=
+ signing.password=
+ signing.secretKeyRingFile=
-## Building the test jar ##
-./gradlew testJar
+### Building the test jar ###
+ ./gradlew testJar
-## Determining how transitive dependencies are added ##
-./gradlew core:dependencies --configuration runtime
+### Determining how transitive dependencies are added ###
+ ./gradlew core:dependencies --configuration runtime
-## Contribution ##
+### Contribution ###
-Kafka is a new project, and we are interested in building the community; we would welcome any thoughts or [patches](https://issues.apache.org/jira/browse/KAFKA). You can reach us [on the Apache mailing lists](http://kafka.apache.org/contact.html).
+Apache Kafka interested in building the community; we would welcome any thoughts or [patches](https://issues.apache.org/jira/browse/KAFKA). You can reach us [on the Apache mailing lists](http://kafka.apache.org/contact.html).
To contribute follow the instructions here:
* http://kafka.apache.org/contributing.html