Jun Rao
71ed6ca336
|
11 years ago | |
---|---|---|
bin | 11 years ago | |
config | 11 years ago | |
contrib | 11 years ago | |
core | 11 years ago | |
examples | 12 years ago | |
lib | 12 years ago | |
perf | 11 years ago | |
project | 11 years ago | |
system_test | 11 years ago | |
.gitignore | 12 years ago | |
.rat-excludes | 13 years ago | |
.reviewboardrc | 11 years ago | |
DISCLAIMER | 13 years ago | |
LICENSE | 12 years ago | |
NOTICE | 12 years ago | |
README.md | 11 years ago | |
kafka-patch-review.py | 11 years ago | |
sbt | 12 years ago | |
sbt.bat | 12 years ago |
README.md
Apache Kafka
See our web site details on the project.
Building It
To build for all supported versions of Scala:
- ./sbt +package
To build for a particular version of Scala (either 2.8.0, 2.8.2, 2.9.1 or 2.9.2):
- ./sbt "++2.8.0 package" or ./sbt "++2.8.2 package" or ./sbt "++2.9.1 package" or ./sbt "++2.9.2 package"
Running It
To run follow the instructions here:
Other Build Tips
Here are some useful sbt commands, to be executed at the sbt command prompt (./sbt). Prefixing with "++ " runs the command for a specific Scala version, prefixing with "+" will perform the action for all versions of Scala, and no prefix runs the command for the default (2.8.0) version of Scala. -
tasks : Lists all the sbt commands and their descriptions clean : Deletes all generated files (the target directory). compile : Compile all the sub projects, but not create the jars test : Run all unit tests in all sub projects release-zip : Create all the jars, run unit tests and create a deployable release zip package: Creates jars for src, test, docs etc projects : List all the sub projects project sub_project_name : Switch to a particular sub-project. For example, to switch to the core kafka code, use "project core-kafka"
The following commands can be run only on a particular sub project - test-only package.test.TestName : Runs only the specified test in the current sub project run : Provides options to run any of the classes that have a main method. For example, you can switch to project java-examples, and run the examples there by executing "project java-examples" followed by "run"
For more details please see the SBT documentation
Contribution
Kafka is a new project, and we are interested in building the community; we would welcome any thoughts or patches. You can reach us on the Apache mailing lists.
To contribute follow the instructions here:
We also welcome patches for the website and documentation which can be found here: