ddragosd closed pull request #3541: Point Getting Started to docker-compose URL: https://github.com/apache/incubator-openwhisk/pull/3541
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/.project b/.project deleted file mode 100644 index 7c8373e369..0000000000 --- a/.project +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<projectDescription> - <name>openwhisk</name> - <comment></comment> - <projects> - </projects> - <buildSpec> - <buildCommand> - <name>org.python.pydev.PyDevBuilder</name> - <arguments> - </arguments> - </buildCommand> - </buildSpec> - <natures> - <nature>org.python.pydev.pythonNature</nature> - </natures> - <filteredResources> - <filter> - <id>1474064946127</id> - <name></name> - <type>30</type> - <matcher> - <id>org.eclipse.ui.ide.orFilterMatcher</id> - <arguments> - <matcher> - <id>org.eclipse.ui.ide.multiFilter</id> - <arguments>1.0-projectRelativePath-matches-false-false-core/invoker</arguments> - </matcher> - <matcher> - <id>org.eclipse.ui.ide.multiFilter</id> - <arguments>1.0-projectRelativePath-matches-false-false-tests</arguments> - </matcher> - <matcher> - <id>org.eclipse.ui.ide.multiFilter</id> - <arguments>1.0-projectRelativePath-matches-false-false-core/controller</arguments> - </matcher> - <matcher> - <id>org.eclipse.ui.ide.multiFilter</id> - <arguments>1.0-projectRelativePath-matches-false-false-common/scala</arguments> - </matcher> - <matcher> - <id>org.eclipse.ui.ide.multiFilter</id> - <arguments>1.0-projectRelativePath-matches-false-false-bin</arguments> - </matcher> - </arguments> - </matcher> - </filter> - <filter> - <id>1474064946128</id> - <name></name> - <type>10</type> - <matcher> - <id>org.eclipse.ui.ide.multiFilter</id> - <arguments>1.0-projectRelativePath-matches-false-false-build</arguments> - </matcher> - </filter> - </filteredResources> -</projectDescription> diff --git a/README.md b/README.md index a8aea706d3..863169c8be 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,27 @@ OpenWhisk is a cloud-first distributed event-based programming service. It provides a programming model to upload event handlers to a cloud service, and register the handlers to respond to various events. Learn more at [http://openwhisk.incubator.apache.org](http://openwhisk.incubator.apache.org). -* [Quick Start](#quick-start) (Vagrant) +* [Quick Start](#quick-start) (Docker-Compose) * [Native development](#native-development) (Mac and Ubuntu) +* [Vagrant](#vagrant-setup) * [Learn concepts and commands](#learn-concepts-and-commands) * [Issues](#issues) * [Slack](#slack) ### Quick Start +The easiest way to start using OpenWhisk is to get Docker installed on on Mac, Windows or Linux. The [Docker website](https://docs.docker.com/install/) has details instructions on getting the tools installed. This does not give you a prodcution deployment but gives you enough of the pieces to start writing functions and seeing them run. -A [Vagrant](http://vagrantup.com) machine is the easiest way to run OpenWhisk on Mac, Windows PC or GNU/Linux. +``` +git clone https://github.com/apache/incubator-openwhisk-devtools.git +cd docker-compose +make quick-start +``` + +For more detailed instructions or if you encounter problems see the [OpenWhisk-dev tools](https://github.com/apache/incubator-openwhisk-devtools/blob/master/docker-compose/README.md) project. + + +### Vagrant Setup +A [Vagrant](http://vagrantup.com) machine is also avaiable to run OpenWhisk on Mac, Windows PC or GNU/Linux but isn't used by as much of the dev team so sometimes lags behind. Download and install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and [Vagrant](https://www.vagrantup.com/downloads.html) for your operating system and architecture. **Note:** For Windows, you may need to install an ssh client in order to use the command `vagrant ssh`. Cygwin works well for this, and Git Bash comes with an ssh client you can point to. If you run the command and no ssh is installed, Vagrant will give you some options to try. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
