From 31da1f9ffc4cd24c0cab0846826acdce45540bc3 Mon Sep 17 00:00:00 2001 From: Sylvain Baubeau Date: Mon, 10 Oct 2016 18:06:10 +0200 Subject: [PATCH] Add quick start and contributing sections to README.md Change-Id: I56c5214d24791adb7885bb3fa76cdce617280073 Reviewed-on: http://softwarefactory-project.io/r/5045 Reviewed-by: Sylvain Afchain Tested-by: Sylvain Afchain Workflow: Sylvain Afchain --- README.md | 24 ++++++++++++++++++++++++ doc/content/contributing.md | 1 - 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c4eb9c8605..8c506dfec3 100644 --- a/README.md +++ b/README.md @@ -13,18 +13,42 @@ Elasticsearch database. Skydive is SDN-agnostic but provides SDN drivers in order to enhance the topology and flows informations. +## Quick start + +To quick set up a working environment, [Docker Compose](https://docs.docker.com/compose/) +can be used to automatically start an Elasticsearch container, a Skydive analyzer +container and a Skydive agent container. + +```console +curl -o docker-compose.yml https://raw.githubusercontent.com/skydive-project/skydive/master/contrib/docker/docker-compose.yml +docker-compose up +``` + +Open a browser to http://localhost:8082 to access the analyzer Web UI. + +You can also use the Skydive [command line client](https://skydive-project.github.io/skydive/getting-started/client/) with: +```console +docker run -ti skydive/skydive client topology query --gremlin "g.V()" +``` + ## Documentation Skydive documentation can be found here: * http://skydive-project.github.io/skydive +## Contributing + +Your contributions are more than welcome. Please check https://skydive-project.github.io/skydive/contributing/ +to know about the process. + ## Contact * IRC: #skydive-project on irc.freenode.net * Mailing list: https://www.redhat.com/mailman/listinfo/skydive-dev ## License + This software is licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. diff --git a/doc/content/contributing.md b/doc/content/contributing.md index a6a11e8ee4..e453f43a34 100644 --- a/doc/content/contributing.md +++ b/doc/content/contributing.md @@ -18,7 +18,6 @@ git-review installation : ```console yum install git-review - ``` or