Repository: zest-java Updated Branches: refs/heads/develop 9a1fed06d -> 160face48
ZEST-143 - Documentation Project: http://git-wip-us.apache.org/repos/asf/zest-java/repo Commit: http://git-wip-us.apache.org/repos/asf/zest-java/commit/28e2b695 Tree: http://git-wip-us.apache.org/repos/asf/zest-java/tree/28e2b695 Diff: http://git-wip-us.apache.org/repos/asf/zest-java/diff/28e2b695 Branch: refs/heads/develop Commit: 28e2b695e124cb19b6f8a606e2c20ac8005e8d8b Parents: 9a1fed0 Author: Niclas Hedhman <[email protected]> Authored: Fri Jun 10 11:29:15 2016 +0800 Committer: Niclas Hedhman <[email protected]> Committed: Fri Jun 10 11:29:15 2016 +0800 ---------------------------------------------------------------------- manual/src/docs/website/intro.txt | 4 ++ tools/shell/src/dist/bin/zest-boot | 0 tools/shell/src/docs/quick-start.txt | 61 +++++++++++++++++++++++++++++++ tools/shell/src/docs/use-boot.txt | 46 +++++++++++++++++++++++ 4 files changed, 111 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/zest-java/blob/28e2b695/manual/src/docs/website/intro.txt ---------------------------------------------------------------------- diff --git a/manual/src/docs/website/intro.txt b/manual/src/docs/website/intro.txt index 1e17772..66142b2 100644 --- a/manual/src/docs/website/intro.txt +++ b/manual/src/docs/website/intro.txt @@ -28,6 +28,10 @@ include::../../../../tutorials/introduction/src/docs/highlights.txt[] :leveloffset: 2 +include::../../../../tools/shell/src/docs/quick-start.txt[] + +:leveloffset: 2 + include::../../../../tutorials/introduction/src/docs/background.txt[] :leveloffset: 2 http://git-wip-us.apache.org/repos/asf/zest-java/blob/28e2b695/tools/shell/src/dist/bin/zest-boot ---------------------------------------------------------------------- diff --git a/tools/shell/src/dist/bin/zest-boot b/tools/shell/src/dist/bin/zest-boot new file mode 100644 index 0000000..e69de29 http://git-wip-us.apache.org/repos/asf/zest-java/blob/28e2b695/tools/shell/src/docs/quick-start.txt ---------------------------------------------------------------------- diff --git a/tools/shell/src/docs/quick-start.txt b/tools/shell/src/docs/quick-start.txt new file mode 100644 index 0000000..50efae5 --- /dev/null +++ b/tools/shell/src/docs/quick-start.txt @@ -0,0 +1,61 @@ +/////////////////////////////////////////////////////////////// + * 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. +/////////////////////////////////////////////////////////////// + +WARNING! This guide is written before the code, and may not work yet. + +[[quick-start,Quick Start Guide]] += Quick Start = +If you want to test Apache Zest in the smallest amount of time possible, +without getting bogged down by the details, you have come to the right +place. + +== Quick Download / No Install == +The following procedure will download one JAR file, one script and put it +on your PATH. + +=== Windows === +TBD. + +=== Linux / Mac OSX === +The assumption is that ==wget== is installed. + +[snippet,bash] +---- +source=tools/shell/src/docs/use-boot.txt +tag=boot-quick +---- + +The boot script will place the the ==zest== script and the accompanying +jar file into the $HOME/bin directory, which should already be on your PATH. + +== Create a small Project == + +[snippet,bash] +---- +source=tools/shell/src/docs/use-boot.txt +tag=create-singleton +---- + +== Create a complete Project == + +[snippet,bash] +---- +source=tools/shell/src/docs/use-boot.txt +tag=create-ngheroes +---- http://git-wip-us.apache.org/repos/asf/zest-java/blob/28e2b695/tools/shell/src/docs/use-boot.txt ---------------------------------------------------------------------- diff --git a/tools/shell/src/docs/use-boot.txt b/tools/shell/src/docs/use-boot.txt new file mode 100644 index 0000000..3f14825 --- /dev/null +++ b/tools/shell/src/docs/use-boot.txt @@ -0,0 +1,46 @@ +/////////////////////////////////////////////////////////////// + * 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. +/////////////////////////////////////////////////////////////// + +THIS FILE CONTAINS SNIPPETS for quick-start.txt and shell.txt. DO NOT INCLUDE IN DOCUMENTATION. + + +START SNIPPET: boot-quick +wget http://zest.apache.org/latest/shell/zest-boot +sh zest-boot quick +END SNIPPET: boot-quick + +START SNIPPET: boot-sdk +wget http://zest.apache.org/latest/shell/zest-boot +sh zest-boot sdk +END SNIPPET: boot-sdk + +START SNIPPET: create-singleton +zest create-project singleton com.acme.quick quickstart +cd quickstart +./gradlew assemble +./gradlew run +END SNIPPET: create-singleton + +START SNIPPET: create-ngheroes +zest create-project ng-heroes com.acme.heroes heroes +cd heroes +./gradlew assemble +./gradlew run +END SNIPPET: create-ngheroes +
