From 27c71ebff800f613e12cbacacd242ca1ef9ad0c1 Mon Sep 17 00:00:00 2001 From: Hardy Ferentschik Date: Mon, 25 Apr 2016 14:52:34 +0200 Subject: [PATCH] Issue #195 Updating README. Improving structure and content --- README.md | 75 ++++++++++++++++++++++++++----------------------------- 1 file changed, 36 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index e360847..0fd2cd5 100644 --- a/README.md +++ b/README.md @@ -3,39 +3,31 @@ - [Objective](#objective) -- [Example Execution of the Plugin](#example-execution-of-the-plugin) -- [Available Commands](#available-commands) -- [Exit codes](#exit-codes) -- [IP Address Detection](#ip-address-detection) -- [Getting Involved with the Project](#getting-involved-with-the-project) - - [Development](#development) - - [Vagrant Spec based tests](#vagrant-spec-based-tests) +- [Usage](#usage) + - [Example execution of the plugin](#example-execution-of-the-plugin) + - [Available commands](#available-commands) + - [Exit codes](#exit-codes) + - [IP address detection](#ip-address-detection) +- [Development](#development) + - [Setup](#setup) + - [Acceptance tests](#acceptance-tests) - [Builds](#builds) +- [Getting involved](#getting-involved) ----- + +# Objective The vagrant-service-manager plugin is designed to enable easier access to the features and services provided by the [Atomic Developer Bundle (ADB)](https://github.com/projectatomic/adb-atomic-developer-bundle). It provides setup information, including environment variables and certificates, required to access services provided by the ADB and is a must have for most ADB users. This plugin makes it easier to use the ADB with host-based tools such as Eclipse and the docker and kubernetes CLI commands. Details on how to use ADB with this plugin can be found in the [ADB Documentation](https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/using.rst). ----- - - -## Objective - -The [ADB](https://github.com/projectatomic/adb-atomic-developer-bundle) provides a ready-to-use development environment for container applications. With ADB, developers can dive right into producing complex, multi-container applications. - -The vagrant-service-manager provides the user with: - -* A CLI to configure the ADB for different use cases and to provide an interface between ADB and the user's development environment. -* A tool to control and configure the ADB from the -developer's workstation without having to `ssh` directly into the ADB virtual machine. - + +# Usage -## Example Execution of the Plugin +## Example execution of the plugin 1. Install vagrant-service-manager plugin: @@ -64,7 +56,7 @@ developer's workstation without having to `ssh` directly into the ADB virtual ma -## Available Commands +## Available commands The following table lists the available commands for the plugin and their explanation: @@ -90,25 +82,19 @@ Exit Code Number | Meaning -## IP Address Detection +## IP address detection There is no standardized way of detecting Vagrant box IP addresses. This code uses the last IPv4 address available from the set of configured addresses that are *up*. i.e. if eth0, eth1, and eth2 are all up and have IPv4 addresses, the address on eth2 is used. - -## Getting Involved with the Project - -We welcome your input. You can submit issues or pull requests with respect to the vagrant-service-manager plugin. Refer to the [contributing guidelines](https://github.com/projectatomic/vagrant-service-manager/blob/master/CONTRIBUTING.md) for detailed information on how to contribute to this plugin. - -You can contact us on: - * IRC: #atomic and #nulecule on freenode - * Mailing List: container-tools@redhat.com - -### Development +# Development + + +## Setup -To setup your development environment install the [Bundler](http://bundler.io/) gem: +After cloing the repository, install the [Bundler](http://bundler.io/) gem: $ gem install bundler @@ -122,8 +108,8 @@ Rake tasks via: $ bundle exec rake -T - -#### Vagrant Spec based tests + +## Acceptance tests The source contains also a set of [vagrant-spec](https://github.com/mitchellh/vagrant-spec) acceptance tests. They can be run via: @@ -137,8 +123,19 @@ In order to for example use _libvirt_ run: $ bundle exec rake acceptance['libvirt'] -### Builds +## Builds - Gem: https://rubygems.org/gems/vagrant-service-manager - - Copr build: https://copr.fedorainfracloud.org/coprs/nshaikh/vagrant-service-manager/builds/ + + +# Getting involved + +We welcome your input. You can submit issues or pull requests with respect to +the vagrant-service-manager plugin. Refer to the +[contributing guidelines](https://github.com/projectatomic/vagrant-service-manager/blob/master/CONTRIBUTING.md) +for detailed information on how to contribute to this plugin. + +You can contact us on: + * IRC: #atomic and #nulecule on freenode + * Mailing List: container-tools@redhat.com