Skip to content

Commit

Permalink
Add quick start and contributing sections to README.md
Browse files Browse the repository at this point in the history
Change-Id: I56c5214d24791adb7885bb3fa76cdce617280073
Reviewed-on: http://softwarefactory-project.io/r/5045
Reviewed-by: Sylvain Afchain <safchain@gmail.com>
Tested-by: Sylvain Afchain <safchain@gmail.com>
Workflow: Sylvain Afchain <safchain@gmail.com>
  • Loading branch information
lebauce authored and safchain committed Oct 11, 2016
1 parent ee81bb0 commit 31da1f9
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion doc/content/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ git-review installation :

```console
yum install git-review

```

or
Expand Down

0 comments on commit 31da1f9

Please sign in to comment.