add super short description in title of software
[challenge-bot] / guide / hausner / overview.org
index b73f7283dd07ac04ccab11da4e3638e5362606f3..1f0e75b01840d7f293623b4c21e5ac7f6a186dbc 100644 (file)
@@ -1,75 +1,71 @@
 #+TITLE:hausner challenge-bot overview
-* challenge-bot robot overview
-** videos for assembling the hardware
-** software
-   software is available as nice neat installable packages for
-   Mac OS X, GNU+Linux, and MS Windows.
+#+SETUPFILE: org-html-themes/setup/theme-readtheorg.setup
+* videos for assembling the hardware
+* software
+  software is available as nice neat installable packages for
+  Mac OS X, GNU+Linux, and MS Windows.
 
-   it's also available in source code form, so you can compile it for
-   other platforms.
+  it's also available in source code form, so you can compile it for
+  other platforms.
 
-   all software used in this robot is available for you to use for any
-   purpose, improve, and, share those improvements (if you want).
-*** arduino
-**** summary
-     control how the robot gets information from sensors, and moves
-     its motors.
-**** download
-     https://www.arduino.cc/en/Main/Software
-*** openscad
-**** summary
-     create robot parts!
+  all software used in this robot is available for you to use for any
+  purpose, improve, and, share those improvements (if you want).
+** robot behavior: arduino
+   control how the robot gets information from sensors, and moves
+   its motors.
 
-     use this program to view parts inside the "3d-printables"
-     directory.  write code to modify the parts and create completely
-     new ones.
-**** download
-     http://www.openscad.org/downloads.html
-*** fritzing
-**** summary
-     wire up components!
-**** download
-     http://fritzing.org/download/?donation=0
-*** 7-zip
-**** summary
-     extract the contents of .tgz files, like the content of this class.
+   https://www.arduino.cc/en/Main/Software
+** 3d modeling: openscad
+   create robot parts!
 
-     this is needed on MS Windows(tm) only.
+   use this program to view parts inside the "3d-printables"
+   directory.  write code to modify the parts and create completely
+   new ones.
 
-     if you are on Mac OS X, or GNU (on cygwin or linux), then you do
-     not need this.  your software will be able to extract the
-     class content
-**** download
-     http://7-zip.org/
-** class content
-   all the source code for the class is available here:
+   http://www.openscad.org/downloads.html
+** wiring: fritzing
+   wire up components!
 
-   http://challenge-bot.com/repos/?p=challenge-bot;a=snapshot;h=232ff7a14f9d8be27362c268c6cdd1b67f59a24a;sf=tgz
+   http://fritzing.org/download/?donation=0
+** extract: 7-zip
+   extract the contents of .tgz files, like the content of this class.
 
-   what follows is a high level description of the contents of the most
-   important top level directories in the class content.
-*** 3d-printables
-    the parts of the robot that are 3d-printed are in this directory.
-    use openscad to open the parts in this directory.
-*** build-stages
-    all the wiring diagrams and arduino code live in this directory.
+   this is needed on MS Windows(tm) only.
 
-    under this directory, there is one subdirectory for each
-    build stage.
-    each build stage is prefixed with a letter to make it appear in
-    order.
-    for example, =a_serial= contains the first build stage.
-** troubleshooting
-    to troubleshoot a misbehaving robot, go through these stages
-    in order until you find a stage that does not work correctly.
+   if you are on Mac OS X, or GNU (on cygwin or linux), then you do
+   not need this.  your software will be able to extract the
+   class content
 
-    first, in =a_serial=, you'll check whether the arduino can
-    communicate over the serial connection with the computer.
+   http://7-zip.org/
+* class content
+  all the source code for the class is available here:
 
-    in each stage, make sure the wires shown in the fritzing
-    diagram are correctly connected on your robot.
-    then load the corresponding arduino sketch to your robot
-    and either check the serial monitor, or turn on the motor battery.
+  http://challenge-bot.com/repos/?p=challenge-bot;a=snapshot;h=232ff7a14f9d8be27362c268c6cdd1b67f59a24a;sf=tgz
 
-    this will help you pinpoint exactly where the problem lies on your
-    robot.
+  what follows is a high level description of the contents of the most
+  important top level directories in the class content.
+** 3d-printables
+   the parts of the robot that are 3d-printed are in this directory.
+   use openscad to open the parts in this directory.
+** build-stages
+   all the wiring diagrams and arduino code live in this directory.
+
+   under this directory, there is one subdirectory for each
+   build stage.
+   each build stage is prefixed with a letter to make it appear in
+   order.
+   for example, =a_serial= contains the first build stage.
+* troubleshooting
+   to troubleshoot a misbehaving robot, go through these stages
+   in order until you find a stage that does not work correctly.
+
+   first, in =a_serial=, you'll check whether the arduino can
+   communicate over the serial connection with the computer.
+
+   in each stage, make sure the wires shown in the fritzing
+   diagram are correctly connected on your robot.
+   then load the corresponding arduino sketch to your robot
+   and either check the serial monitor, or turn on the motor battery.
+
+   this will help you pinpoint exactly where the problem lies on your
+   robot.