restructured (har har) docs and added flashing instructions for parad…

…rop boards
ParadropLabs · Jul 28, 2015 · ad95a7c · ad95a7c
1 parent 22f26be
commit ad95a7c
Show file tree

Hide file tree

Showing 11 changed files with 132 additions and 22 deletions.
diff --git a/docs/arch/architecture.rst b/docs/arch/architecture.rst
@@ -0,0 +1,6 @@
+Architecture
+====================================
+
+This section details some of the non-obvious architectural features of paradrop. 
+
+This is a work in progress. Check back later!
diff --git a/docs/chutes.rst b/docs/chutes.rst
diff --git a/docs/chutes/chutedev.rst b/docs/chutes/chutedev.rst
@@ -0,0 +1,15 @@
+Developing chutes
+====================================
+
+Wondering how to make applications that run on paradrop? Well wonder no more!
+
+This is a work in progress. Check back later!
+
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   installation
diff --git a/docs/chutes/installation.rst b/docs/chutes/installation.rst
@@ -0,0 +1,94 @@
+Installing Paradrop
+====================================
+
+Paradrop is distributed as a "snap," or an application that runs on snappy. You can run snappy on any x86 or armv7 board (Raspberry Pi Gen 2 or Beagleboard Black supported!) 
+
+To setup paradrop you need to install snapy on your hardware of choice and then have snappy install paradrop. This is a temporary method until more robust installation tools are finished. 
+
+
+
+Flashing x86 Paradrop Boards
+++++++++++++++++++++++++++++
+
+These instructions apply to x86 routers distributed by the Paradrop development team. 
+
+Download snappy here: `Ubuntu Snappy <http://releases.ubuntu.com/15.04/ubuntu-15.04-snappy-amd64-generic.img.xz>`_
+
+or run::
+
+    wget http://releases.ubuntu.com/15.04/ubuntu-15.04-snappy-amd64-generic.img.xz 
+    unxz ubuntu-15.04-snappy-amd64-generic.img.xz
+
+
+Run the following command from terminal to verify the path of SD card::
+
+    diskutil list
+
+The output shows all the disks current mounted on the system. Look for the path of your SD card by size and name::
+
+    /dev/disk3
+    #:                       TYPE NAME                    SIZE       IDENTIFIER
+    0:     FDisk_partition_scheme                        *8.0 GB     disk3
+    1:                 DOS_FAT_32 RPISDCARD               8.0 GB     disk3s1
+
+
+In this example ``dev/disk3`` is the path the SD card. 
+
+Unmount the current partition on the SD card in order to sucessfully use @dd@ to write::
+    
+    diskutil unmount /dev/disk3s1
+
+Use ``dd`` command to write image file (Note the ``r`` added to ``rdisk3`` which drastically improves write performance) to the disk. (Note: ``bs`` stands for block size in bytes.)
+
+
+Go to the directory where your .img located and run command below::
+
+    sudo dd if=ubuntu-15.04-snappy-amd64-generic.img of=/dev/rdisk3 bs=2m
+
+Different SD card take different time to finish the process. use @CTRL+T@ to see the current status of @dd@.
+
+
+First boot: SSH through serial
+----------------------------------------
+
+Connect the serial output through USB and start Putty section with @baud rate of 9600@. Plug in SD card into the router and plug in power. The Ubuntu Snappy should automatically boots and runs. 
+
+*Note:* baud rate of 115200 *will not* boot you into the system, *9600* works perfect.  
+
+Once you access the device, Log into the Ubuntu Snappy with login/password below::
+
+    login: ubuntu  
+    password: ubuntu
+
+`See here <https://developer.ubuntu.com/en/snappy/tutorials/using-snappy/>`_ for some basic snappy commands.
+
+Lets test the wireless card's functionality. To bring wirelss ``wlan0`` up::
+
+    sudo ifconfig wlan0 up
+
+Search SSIDs nearby with ``scan``::
+
+    sudo iw dev wlan0 scan
+
+If everything works fine, you should expect to see list of different SSIDs around your router. 
+
+
+On RaspberryPi Generation 2
+++++++++++++++++++++++++++++
+
+
+Make sure your Raspberry Pi is the Generation 2 version, otherwise, all Gen1 will not work since Ubuntu Snappy requires ``ARMv7`` architecture.
+
+Flashing image into MicroSD card for RaspberryPi 2 is similar to the instruction above. 
+Download the corresponding images and following the instruction above should work. 
+
+Detail instructions can be found `here <https://developer.ubuntu.com/en/snappy/start/#snappy-raspi2>`_
+
+
+h2. On BegalBone Black
+++++++++++++++++++++++++++++
+
+Flashing image into MicroSD card for BegalBone Black is similar to the instruction above. 
+Download the corresponding images and following the instruction above should work. 
+
+Detail instructions can be found `here <https://developer.ubuntu.com/en/snappy/start/#try-beaglebone>`_
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,17 +6,26 @@
 Paradrop
 ====================================
 
-TL;DR
------
+Get started writing chutes with :doc:`chutes/chutedev`. 
 
-Get started coding right away with the :doc:`quickstart`. 
+Learn how to help develop paradrop at :doc:`pd/paradropdev`. 
 
 .. toctree::
    :maxdepth: 2
    :hidden:
 
-   chutes
-   development
+   chutes/chutedev
+   pd/paradropdev
+   arch/architecture
    api/modules
 
-.. include:: overview.rst
+Overview
+====================================
+
+Paradrop is a software platform that enables developers to create applications (or "chutes") that run on wireless routers. Chutes can be given full control over their router and can monitor traffic, filter traffic, or create their own wireless networks. 
+
+It runs on top of `Ubuntu Snappy <https://developer.ubuntu.com/en/snappy/>`_ , a trimmed-down and secured operating system that can run on ARM and x86. `Docker <https://www.docker.com/>`_ provides encapsulation for chutes through Linux Containers.
+
+To get started developing on (or for!) paradrop, check out :doc:`quickstart`. 
+
+For a descriptive explination of paradrop's build process, see :doc:`build system`. 
diff --git a/docs/overview.rst b/docs/overview.rst
diff --git a/docs/apparmor.rst → docs/pd/apparmor.rst b/docs/apparmor.rst → docs/pd/apparmor.rst
diff --git a/docs/build system.rst → docs/pd/build system.rst b/docs/build system.rst → docs/pd/build system.rst
diff --git a/docs/doctests.rst → docs/pd/doctests.rst b/docs/doctests.rst → docs/pd/doctests.rst
diff --git a/docs/development.rst → docs/pd/paradropdev.rst b/docs/development.rst → docs/pd/paradropdev.rst
@@ -3,10 +3,12 @@ Developing for paradrop
 
 Ready to get started with paradrop? This section can help you understand how paradrop is built and how to use the provided tools to get up and running right away. 
 
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
+   :hidden:
 
    quickstart
    build system

diff --git a/docs/quickstart.rst → docs/pd/quickstart.rst b/docs/quickstart.rst → docs/pd/quickstart.rst