Update docs

hybridgroup · Oct 28, 2014 · fd24e6a · fd24e6a
1 parent 6bd4690
commit fd24e6a
Show file tree

Hide file tree

Showing 75 changed files with 62 additions and 1,162 deletions.
diff --git a/api/doc.go b/api/doc.go
@@ -1,6 +1,5 @@
 /*
-Package api provides functionally to expose your gobot programs
-to other by using starting a web server and adding commands.
+Package api provides a webserver to interact with your Gobot program over the network.
 
 Example:
 

diff --git a/doc.go b/doc.go
@@ -1,7 +1,8 @@
 // Copyright 2014 The Gobot Authors, HybridGroup. All rights reserved.
 
 /*
-Package gobot is the main point of entry in your Gobot application. A Gobot
+Package gobot provides a framework for robotics, physical computing and the internet of things.
+It is the main point of entry in your Gobot application. A Gobot
 is typically composed of one or more robots that makes up a project.
 
 Commands are a way to expose your robots functionality with the external world.

diff --git a/examples/beaglebone_basic_direct_pin.go b/examples/beaglebone_basic_direct_pin.go
@@ -1,4 +1,3 @@
-// Use Gobot to control BeagleBone's digital pins directly
 package main
 
 import (
@@ -8,8 +7,10 @@ import (
 
 func main() {
 
+	// Use Gobot to control BeagleBone's digital pins directly
+
 	beagleboneAdaptor := beaglebone.NewBeagleboneAdaptor("beaglebone")
-	gpioPin           := gpio.NewDirectPinDriver(beagleboneAdaptor, "myDevice", "P9_12")
+	gpioPin := gpio.NewDirectPinDriver(beagleboneAdaptor, "myDevice", "P9_12")
 
 	// Initialize the internal representation of the pinout
 	beagleboneAdaptor.Connect()

diff --git a/gobot/doc.go b/gobot/doc.go
@@ -0,0 +1,22 @@
+/*
+CLI tool for generating new Gobot projects.
+
+	NAME:
+		 gobot - Command Line Utility for Gobot
+
+	USAGE:
+		 gobot [global options] command [command options] [arguments...]
+
+	VERSION:
+		 0.1
+
+	COMMANDS:
+		 generate     Generate new Gobot skeleton project
+		 help, h      Shows a list of commands or help for one command
+
+	GLOBAL OPTIONS:
+		 --help, -h           show help
+		 --version, -v        print the version
+
+*/
+package main
diff --git a/platforms/ardrone/doc.go b/platforms/ardrone/doc.go
@@ -1,9 +1,9 @@
 /*
-This package provides the Gobot adaptor and driver for the [Parrot Ardrone](http://ardrone2.parrot.com).
+Package ardrone provides the Gobot adaptor and driver for the Parrot Ardrone.
 
 Installing:
 
-	go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/ardrone
+	go get github.com/hybridgroup/gobot/platforms/ardrone
 
 Example:
 

diff --git a/platforms/ardrone/docs/commands_flight.md b/platforms/ardrone/docs/commands_flight.md
diff --git a/platforms/ardrone/docs/events_flight.md b/platforms/ardrone/docs/events_flight.md
diff --git a/platforms/beaglebone/doc.go b/platforms/beaglebone/doc.go
@@ -1,9 +1,9 @@
 /*
-This package provides the Gobot adaptor for the Beaglebone Black (http://beagleboard.org/Products/BeagleBone+Black/)
+Package beaglebone provides the Gobot adaptor for the Beaglebone Black.
 
 Installing:
 
-	go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/platforms/gobot/beaglebone
+	go get github.com/hybridgroup/platforms/gobot/beaglebone
 
 Example:
 

diff --git a/platforms/digispark/doc.go b/platforms/digispark/doc.go
@@ -1,12 +1,12 @@
 /*
-This package provides the Gobot adaptor for the [Digispark](http://digistump.com/products/1) ATTiny-based USB development board with the [Little Wire](http://littlewire.cc/) protocol firmware installed.
+Package digispark provides the Gobot adaptor for the Digispark ATTiny-based USB development board.
 
 Installing:
 
 This package requires installing `libusb`.
 Then you can install the package with:
 
-	go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/digispark
+	go get github.com/hybridgroup/gobot/platforms/digispark
 
 Example:
 

diff --git a/platforms/firmata/doc.go b/platforms/firmata/doc.go
@@ -1,10 +1,9 @@
 /*
-
-This package provides the adaptor for microcontrollers such as Arduino that support the [Firmata](http://firmata.org/wiki/Main_Page) protocol
+Package firmata provides the Gobot adaptor for microcontrollers that support the Firmata protocol.
 
 Installing:
 
-	go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/firmata
+	go get github.com/hybridgroup/gobot/platforms/firmata
 
 ## Example
 

diff --git a/platforms/gpio/doc.go b/platforms/gpio/doc.go
@@ -1,9 +1,9 @@
 /*
-This package provides drivers for General Purpose Input/Output (GPIO) (https://en.wikipedia.org/wiki/General_Purpose_Input/Output) devices . It is normally not used directly, but instead is registered by an adaptor such as firmata (https://github.com/hybridgroup/gobot/platforms/firmata) that supports the needed interfaces for GPIO devices.
+Package gpio provides Gobot drivers for General Purpose Input/Output devices.
 
 Installing:
 
-	go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/gpio
+	go get github.com/hybridgroup/gobot/platforms/gpio
 
 For further information refer to gpio README:
 https://github.com/hybridgroup/gobot/blob/master/platforms/gpio/README.md

diff --git a/platforms/gpio/docs/.DS_Store b/platforms/gpio/docs/.DS_Store
diff --git a/platforms/gpio/docs/breadboards/analog_sensor.fzz b/platforms/gpio/docs/breadboards/analog_sensor.fzz
diff --git a/platforms/gpio/docs/breadboards/analog_sensor_bb.png b/platforms/gpio/docs/breadboards/analog_sensor_bb.png
diff --git a/platforms/gpio/docs/breadboards/banana.png b/platforms/gpio/docs/breadboards/banana.png
diff --git a/platforms/gpio/docs/breadboards/button.fzz b/platforms/gpio/docs/breadboards/button.fzz
diff --git a/platforms/gpio/docs/breadboards/button_bb.png b/platforms/gpio/docs/breadboards/button_bb.png
diff --git a/platforms/gpio/docs/breadboards/hand.png b/platforms/gpio/docs/breadboards/hand.png
diff --git a/platforms/gpio/docs/breadboards/led.fzz b/platforms/gpio/docs/breadboards/led.fzz
diff --git a/platforms/gpio/docs/breadboards/led_bb.png b/platforms/gpio/docs/breadboards/led_bb.png
diff --git a/platforms/gpio/docs/breadboards/makey_button.fzz b/platforms/gpio/docs/breadboards/makey_button.fzz
diff --git a/platforms/gpio/docs/breadboards/makey_button_bb.png b/platforms/gpio/docs/breadboards/makey_button_bb.png
diff --git a/platforms/gpio/docs/breadboards/maxbotix.fzz b/platforms/gpio/docs/breadboards/maxbotix.fzz
diff --git a/platforms/gpio/docs/breadboards/maxbotix_bb.png b/platforms/gpio/docs/breadboards/maxbotix_bb.png
diff --git a/platforms/gpio/docs/breadboards/motor.fzz b/platforms/gpio/docs/breadboards/motor.fzz
diff --git a/platforms/gpio/docs/breadboards/motor_bb.png b/platforms/gpio/docs/breadboards/motor_bb.png
diff --git a/platforms/gpio/docs/breadboards/servo.fzz b/platforms/gpio/docs/breadboards/servo.fzz
diff --git a/platforms/gpio/docs/breadboards/servo_bb.png b/platforms/gpio/docs/breadboards/servo_bb.png
diff --git a/platforms/gpio/docs/commands_analog_sensor.md b/platforms/gpio/docs/commands_analog_sensor.md
diff --git a/platforms/gpio/docs/commands_direct_pin.md b/platforms/gpio/docs/commands_direct_pin.md
diff --git a/platforms/gpio/docs/commands_led.md b/platforms/gpio/docs/commands_led.md
diff --git a/platforms/gpio/docs/commands_makey.md b/platforms/gpio/docs/commands_makey.md