set execute permissions (again!)
[zumo-cc3200/zumo-cc3200.git] / README.html
1 <!DOCTYPE html>
2 <html xmlns="http://www.w3.org/1999/xhtml">
3   <head>
4     <title>Zumo CC3200 README.md</title>
5     <link rel="stylesheet" type="text/css" href="etc/github-markdown.css">
6     <style>
7       .markdown-body {
8          min-width: 200px;
9          max-width: 790px;
10          margin: 0 auto;
11          padding: 30px;
12       }
13     </style>
14   </head>
15   <body ><article class="markdown-body">
16 <p><a href="https://git.ti.com/zumo-cc3200/zumo-cc3200/archive-tarball/master"><img src="etc/build.svg" alt="download" title="" /></a></p>
18 <h1><a href="http://processors.wiki.ti.com/index.php/ZumoCC3200#The_Zumo_CC3200" title="ZumoCC3200 Home Page">Zumo CC3200</a></h1>
20 <p>The Zumo CC3200 project was created to enable makers to easily create
21 applications that leverage the power of a <a href="http://www.ti.com/product/cc3200">TI CC3200</a> connected to a
22 motorized hardware platform equipped with Inertial Measurement (IMU) 
23 sensors.</p>
25 <p>This repository provides an Energia library, ZumoCC3200, that provides core
26 functions that make it possible to create applications with very little code
27 and without requiring in-depth knowledge of the CC3200 or the specific IMU
28 sensors used to enable closed-loop motor control.  As with most libraries, 
29 ZumoCC3200 includes numerous examples that serve as starting points for
30 new projects.</p>
32 <p>Each of the ZumoCC3200 examples consists of two programs: an Energia program
33 that runs on the Zumo CC3200 robot and a <a href="https:/processing.org" title="Processing Home Page">Processing</a>
34 sketch that runs on your laptop. These two programs communicate with one
35 another via WiFi, enabling you to view telemetry data and control the bot
36 from your laptop.</p>
38 <h2><a href="https://gitorious.design.ti.com/sb/zumo/trees/master/src/Energia/libraries" title="ZumoCC3200 Energia Library Sources">The ZumoCC3200 Library</a></h2>
40 <p>To use the ZumoCC3200 library, </p>
42 <ul>
43 <li><a href="https://git.ti.com/zumo-cc3200/zumo-cc3200/archive-tarball/master" title="ZumoCC3200 Repo Download">Download the ZumoCC3200 library</a>, </li>
44 <li><a href="http://processors.wiki.ti.com/index.php/ZumoCC3200Demos#Install_the_Energia_ZumoCC3200_Library" title="ZumoCC3200 Energia Library Install Instructions">Install the ZumoCC3200 library</a> into your Energia
45 sketchbook, and</li>
46 <li><a href="http://processors.wiki.ti.com/index.php/ZumoCC3200Demos#Build_and_Upload_a_Zumo_CC3200_Example" title="ZumoCC3200 Energia Build Instructions">Build and run an example</a></li>
47 </ul>
49 <p>Like most Energia/Arduino libraries, the ZumoCC3200 library includes serveral
50 examples that serve as simple starting points for your project.</p>
52 <h2><a href="https://gitorious.design.ti.com/sb/zumo/trees/master/src/Processing" title="ZumoCC3200 Processing Sketch Sources">Processing Sketches</a></h2>
54 <p>The Processing sketches that communicate with the ZumoCC3200 bot are also 
55 <a href="https://gitorious.design.ti.com/sb/zumo/trees/master/src/Processing" title="ZumoCC3200 Processing Sketch Sources">included in this repo</a>.  Note that some of these sketches
56 rely on freely available Contributed libraries that must be installed.  </p>
58 <p>Prerequisite libraries and installation instructions for these sketches is
59 <a href="http://processors.wiki.ti.com/index.php/ZumoCC3200Demos#Install_Processing_Libraries" title="Processing Library Install Instructions">here</a>.</p>
61 <h2><a href="license.html">License</a></h2>
63 <p>All of the files in this repo are Open Source and most are licensed under 
64 either a BSD 3-clause or MIT license.  However, one file does come with a
65 GPL-2.0 license.  </p>
67 <p>Complete license details are provided <a href="license.html">here</a>.</p>
69 <h2>Contributing</h2>
71 <p><a href="http://processors.wiki.ti.com/index.php/ZumoCC3200#The_Zumo_CC3200" title="ZumoCC3200 Home Page">Zumo CC3200</a> is a collaborative project originally created as a part of the TI Santa Barbara 2015 Summer Intern program by <a href="http://processors.wiki.ti.com/index.php/ZumoCC3200#Credits" title="Interns">Adam Dai and Tony Oliverio</a>, and you are invited to help. </p>
73 <p>In-depth details about contributing code, bug fixes, and documentation are
74 forthcoming.  </p>
75   </article></body>
76 </html>