Merge lp:~jose/charms/precise/distcc/fix-various into lp:charms/distcc

[José Antonio Rey]

Added categories and icon, reformatted README to Markdown

Added icon

Added categories

Changed README to Markdown, as it's now used by CharmWorld

[lp:~jose/charms/precise/distcc/fix-various]

10. By José Antonio Rey on 2014-04-16

Removed icon as it didn't comply with CS policies

11. By José Antonio Rey on 2014-04-16

Improved README file

[Charles Butler (lazypower)]

Thanks Jose!

LGTM, Merging.

review: Approve

=== removed file 'README'
--- README	2012-03-05 15:43:20 +0000
+++ README	1970-01-01 00:00:00 +0000
@@ -1,43 +0,0 @@
-distcc is a program to distribute builds of C, C++, Objective C or Objective C++ code across several machines on a network. distcc should always generate the same results as a local build, is simple to install and use, and is usually much faster than a local compile.
-
-distcc does not require all machines to share a filesystem, have synchronized clocks, or to have the same libraries or header files installed. They can even have different processors or operating systems, if cross-compilers are installed.
-
-More information about distcc at: http://www.distcc.org
-
-
-About this charm
-
-It's a pretty simple charm that provides a peer interface ( distcc-cluster ).  This interface allows you to deploy the distcc charm as a single node and add-unit to create a distcc farm or, deploy x number of them in one command to easily create a distcc farm.
-
-The configurable options are pretty self explanatory and are detailed below:
-
-options:
-  port:
-    default: 3632
-    type: int
-    description: Port to use to run distcc
-  nice:
-    default: 10
-    type: int
-    description: You can specify a (positive) nice level for the distcc process here
-  jobs:
-    default: 10
-    type: int
-    description: You can specify a maximum number of jobs, the server will accept concurrently.
-  zeroconf:
-    default: false
-    type: string
-    description: Enable Zeroconf support?# If enabled, distccd will register via mDNS/DNS-SD. It can then automatically be found by zeroconf enabled distcc clients without the need of a manually configured host list.
-  distcc_options:
-    default: cpp,lzo
-    type: string
-    description: distcc options for each host in the farm
-  existing_distcc:
-    default: auto
-    type: string
-    description: Connect this node to an existing distcc ( host:port ).
-
-
-Note:  To be able to connect distcc to an _existing_ distcc farm ( by changing the existing_distcc option ), this service needs to be exposed.
-
-

=== added file 'README.md'
--- README.md	1970-01-01 00:00:00 +0000
+++ README.md	2014-04-16 03:09:38 +0000
@@ -0,0 +1,56 @@
+# Overview
+
+distcc is a program to distribute builds of C, C++, Objective C or Objective C++
+code across several machines on a network. distcc should always generate the
+same results as a local build, is simple to install and use, and is usually much
+faster than a local compile.
+
+distcc does not require all machines to share a filesystem, have synchronized
+clocks, or to have the same libraries or header files installed. They can even
+have different processors or operating systems, if cross-compilers are
+installed.
+
+More information about distcc can be found [here](http://www.distcc.org).
+
+
+# Usage
+
+It's a pretty simple charm that provides a peer interface (distcc-cluster). This
+interface allows you to deploy the distcc charm as a single node and add-unit to
+create a distcc farm or, deploy x number of them in one command to easily create
+a distcc farm.
+
+First, start by bootstrapping your environment:
+
+    juju bootstrap
+
+Then, deploy the service:
+
+    juju deploy distcc
+
+Finally, expose the service to the world:
+
+    juju expose distcc
+
+You can check the public address of the instance by executing `juju status`.
+
+# Configuration
+
+The configurable options are pretty self explanatory and are detailed below:
+
+ * port: Port to use to run distcc (default: 3632)
+ * nice: You can specify a (positive) nice level for the distcc process here
+   (default: 10)
+ * jobs: You can specify a maximum number of jobs, the server will accept
+   concurrently (default: 10)
+ * zeroconf: Enable Zeroconf support? If enabled, distccd will register via
+   mDNS/DNS-SD. It can then automatically be found by zeroconf enabled distcc
+   clients without the need of a manually configured (default: false) host list.
+ * distcc_options: distcc options for each host in the farm (default: cpp,lzo)
+ * existing_distcc: Connect this node to an existing distcc (host:port)
+   (default: auto)
+
+Note: To be able to connect distcc to an _existing_ distcc farm (by changing the
+existing_distcc option), this service needs to be exposed.
+
+

=== modified file 'metadata.yaml'
--- metadata.yaml	2012-05-22 06:08:01 +0000
+++ metadata.yaml	2014-04-16 03:09:38 +0000
@@ -8,6 +8,11 @@
   significantly faster than a local compile.  distcc does not require
   all machines to share a filesystem, have synchronized clocks, or to
   have the same libraries or header files installed.
+categories:
+  - applications
+provides:
+  distcc-server:
+    interface: distcc-server
 peers:
   distcc-cluster:
     interface: distcc-cluster