Merge pull request #45 from grobie/documentation-updates

Documentation updates

.gitignore

@@ -1,20 +1,22 @@
+*#
+*.[568ao]
+*.a[568o]
+*.cgo*.c
+*.cgo*.go
+*.conf
+*.exe
+*.orig
+*.pyc
+*.rej
+*.rules
+*.so
+*~
+.*.swp
+._*
 .DS_Store
 .git
 .gitignore
-*.[568ao]
-*.a[568o]
-*.so
-*.pyc
-._*
 .nfs.*
 [568a].out
-*~
-*.orig
-*.rej
-*.exe
-.*.swp
-core
-*.cgo*.go
-*.cgo*.c
 _cgo_*
-*#
+core

README.md

@@ -1,27 +1,36 @@
-Prometheus
-==========
+# Prometheus
 
 Bedecke deinen Himmel, Zeus!  A new kid is in town.
 
-Prerequisites
-=============
-1.  Go 1.0.X.
-2.  LevelDB: (https://code.google.com/p/leveldb/).
-3.  Protocol Buffers Compiler: (http://code.google.com/p/protobuf/).
-4.  goprotobuf: the code generator and runtime library: (http://code.google.com/p/goprotobuf/).
-5.  Levigo, a Go-wrapper around LevelDB's C library: (https://github.com/jmhodges/levigo).
 
-Initial Hurdles
-===============
-1.  A bit of this grew organically without an easy way of binding it all together.  The tests will pass but slowly.  They were not optimized for speed but end-to-end coverage of the whole storage model.  This is something immediate to fix.
-2.  Protocol Buffer generator for Go changed emitted output API.  This will need to be fixed before other contributors can participate.
+## Prerequisites
+
+  1. Go 1.0.X.
+  2. LevelDB: (https://code.google.com/p/leveldb/).
+  3. Protocol Buffers Compiler: (http://code.google.com/p/protobuf/).
+  4. goprotobuf: the code generator and runtime library: (http://code.google.com/p/goprotobuf/).
+  5. Levigo, a Go-wrapper around LevelDB's C library: (https://github.com/jmhodges/levigo).
+  6. GoRest, a RESTful style web-services framework: (http://code.google.com/p/gorest/).
+  7. Prometheus Client, Prometheus in Prometheus (https://github.com/matttproud/golang_instrumentation).
+
+## Getting started
+
+For basic help how to get started:
+
+  * [Getting started on Mac OSX](guides/getting-started-osx.md)
 
 
-Milestones
-==========
-1.  In-memory archive, basic rule language, simple computation engine, and naive exposition system.
+## Initial Hurdles
+
+  1. A bit of this grew organically without an easy way of binding it all together.  The tests will pass but slowly.  They were not optimized for speed but end-to-end coverage of the whole storage model.  This is something immediate to fix.
+  2. Protocol Buffer generator for Go changed emitted output API.  This will need to be fixed before other contributors can participate.
 
 
-License
-=======
+## Milestones
+
+  1. In-memory archive, basic rule language, simple computation engine, and naive exposition system.
+
+
+## License
+
 Apache License 2.0

guides/getting-started-osx.md

@@ -0,0 +1,47 @@
+# Getting started
+
+## Installation
+
+### Go
+
+First, create a `$HOME/mygo` directory and its src subdirectory:
+
+    mkdir -p $HOME/mygo/src # create a place to put source code
+
+Next, set it as the GOPATH. You should also add the bin subdirectory to your PATH environment variable so that you can run the commands therein without specifying their full path. To do this, add the following lines to `$HOME/.profile` (or equivalent):
+
+    export GOPATH=$HOME/mygo
+    export PATH=$PATH:$HOME/mygo/bin
+
+Now you can install Go:
+
+    brew install go
+
+
+### Dependencies
+
+Install leveldb and protobuf dependencies:
+
+    brew install leveldb protobuf
+
+
+### Libraries
+
+    go get code.google.com/p/goprotobuf/{proto,protoc-gen-go}
+    go get github.com/jmhodges/levigo
+    go get code.google.com/p/gorest
+    go get github.com/matttproud/{prometheus,golang_instrumentation}
+
+
+## Build
+
+    cd ${GOPATH}/src/github.com/matttproud/prometheus
+    make build
+
+## Configure
+
+    cp prometheus.conf.example prometheus.conf
+
+## Run
+
+    ./prometheus

prometheus.conf.example

@@ -0,0 +1,24 @@
+global {
+  scrape_interval = "1s"
+  evaluation_interval = "1s"
+  labels {
+    monitor = "test"
+  }
+  rule_files = [
+    "prometheus.rules"
+  ]
+}
+
+job {
+  name = "prometheus"
+  scrape_interval = "5s"
+
+  targets {
+    endpoints = [
+      "http://localhost:9090/metrics.json"
+    ]
+    labels {
+      group = "canary"
+    }
+  }
+}