You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@toree.apache.org by ch...@apache.org on 2017/02/15 21:02:46 UTC
incubator-toree git commit: Added disclaimer about needing docker for
release
Repository: incubator-toree
Updated Branches:
refs/heads/0.1.x 7b5bcd8b2 -> 93c0ef015
Added disclaimer about needing docker for release
Project: http://git-wip-us.apache.org/repos/asf/incubator-toree/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-toree/commit/93c0ef01
Tree: http://git-wip-us.apache.org/repos/asf/incubator-toree/tree/93c0ef01
Diff: http://git-wip-us.apache.org/repos/asf/incubator-toree/diff/93c0ef01
Branch: refs/heads/0.1.x
Commit: 93c0ef015caaaca65c4ff37cde5074de3a17f44f
Parents: 7b5bcd8
Author: Chip Senkbeil <ch...@gmail.com>
Authored: Wed Feb 15 15:02:29 2017 -0600
Committer: Chip Senkbeil <ch...@gmail.com>
Committed: Wed Feb 15 15:02:29 2017 -0600
----------------------------------------------------------------------
README.md | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-toree/blob/93c0ef01/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index f3ad970..c8a4ec4 100644
--- a/README.md
+++ b/README.md
@@ -42,15 +42,16 @@ Tests can be run by doing `make test`.
Build & Package
===============
-To build and package up Toree, run
+To build and package up Toree, you currently need `docker` installed. Once you do, run
```
make release
```
-This results in 2 packages.
+This results in 3 packages.
+- `./dist/toree-<VERSION>-source-release.tar.gz` is an archive containing the source used to build the binary
- `./dist/toree-<VERSION>-binary-release.tar.gz` is a simple package that contains JAR and executable
-- `./dist/toree-<VERSION>.tar.gz` is a `pip` installable package that adds Toree as a Jupyter kernel.
+- `./dist/toree-<VERSION>.tar.gz` is a `pip` installable package that adds Apache Toree as a Jupyter kernel
NOTE: `make release` uses `docker`. Please refer to `docker` installation instructions for your system. `USE_VAGRANT` is not supported by this `make` target.