Current location

narf Source control manager Git

aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNick Daly <Nick.M.Daly@gmail.com>2012-07-06 19:52:21 -0500
committerNick Daly <Nick.M.Daly@gmail.com>2012-07-06 19:52:21 -0500
commit9ae886f96fc7017964f05c389b1f4785fea2b7e5 (patch)
tree83ae3c6f8d834d2e48d644778ba697c6dd76b156 /README
parent8ce34fe6f821408ba3873122609c7fe3e425e915 (diff)
Updated readme to reflect new building methods.
Diffstat (limited to 'README')
-rw-r--r--README107
1 files changed, 81 insertions, 26 deletions
diff --git a/README b/README
index b4a33ee..c7c36c8 100644
--- a/README
+++ b/README
@@ -1,9 +1,25 @@
Freedom-Maker - Bdale's building tools for the FreedomBox project
-The general idea for now is that we're going to populate a USB stick
-with a Debian 'wheezy' system that can be used to boot a DreamPlug. Once
-the plug is running on the USB stick, a script on the stick can be used to
-copy the stick contents to the internal 2gb microSD card.
+Welcome to the FreedomBox! This project is the central hub of the FreedomBox
+project, it builds and installs the file-system image that turns any computer
+into a FreedomBox.
+
+There are a couple ways to use this system:
+
+1. If you just want to use a FreedomBox and don't care about changing how it
+ works or mucking about in its insides (if you're like most people), you
+ should get a pre-built image from someone and copy it to an SD card or USB
+ drive. If you don't have a JTAG or don't know what one is, make sure to ask
+ for the SD card image.
+
+2. If you want to change and build on it, you can use:
+
+ A. A USB stick. This requires a JTAG, but doesn't require opening up the
+ DreamPlug), or,
+
+ B. A microSD card and adapter. You can use the one from inside the
+ DreamPlug. You won't need a JTAG, but you will need to open the DreamPlug
+ and void the warranty.
***
*** Warning! There are no "training wheels" here .. read the scripts and
@@ -12,33 +28,71 @@ copy the stick contents to the internal 2gb microSD card.
# To Use It
-Partition a USB stick to have a small FAT partition and large ext2 partition,
-create a /media/freedom mount point, and add entries to /etc/fstab like:
+You'll need to copy the image to the memory card or USB stick:
+
+1. Figure out which device your card actually is.
+
+ A. Unplug your card.
+
+ B. Run "df" to show you the list of devices your computer actually knows
+ about.
+
+ C. Plug your card in.
+
+ D. Run "df" again, your computer should know about a new device or two: your
+ memory card. It's probably "/dev/sd(someletter)". It *won't be*
+ /dev/sda.
+
+2. Decompress the image:
+
+ $ tar -xjvf freedombox-unstable_*.tar.bz2
+
+3. Copy the image to your card. Whatever you do, make sure you don't copy it to
+ /dev/sda. That'll break your system.
+
+ # dd bs=1M if=freedombox-unstable_*.img of=/dev/sd(thesameletter)
+
+Now, what you need to do depends on whether you're using the microSD card or USB
+stick method:
- /dev/sdb1 /media/freedom/boot vfat user,noauto 0 0
- /dev/sdb2 /media/freedom ext2 user,noauto 0 0
+- USB drive: You'll hook the JTAG up to the DreamPlug before booting and use the JTAG
+ to control the boot process, so we can boot from the USB drive.
+
+- microSD card: You'll put the microSD card into the DreamPlug's internal
+ microSD card slot and boot the DreamPlug. It'll restart once to finish the
+ install process, then it's ready to use.
-This will allow the Makefile to mount and unmount the stick at will.
+## Running from a microSD Card
-Update the file fbx-base.conf setting the source= line to your favorite
-Debian mirror.
+When DD has finished, take the microSD card out of your computer and plug it
+into your DreamPlug. If you have a JTAG, you can watch it boot. You'll see it
+restart once during the boot process. If you don't have a JTAG, wait a while (5
+minutes or less) and it'll be available over SSH (port 22). You might need to
+use nmap to find it:
-To populate the stick with bits for a DreamPlug, just plug it in to your
-computer and type:
+ $ nmap -p 22 --open -sV 192.168.0.0/24
+
+ ...
+ Interesting ports on 192.168.0.13:
+ PORT STATE SERVICE VERSION
+ 22/tcp open ssh OpenSSH 6.0p1 Debian 2 (protocol 2.0)
+ Service Info: OS: Linux
+ ...
- make
+Once you've found it, SSH into the box:
+
+ $ ssh root@192.168.0.13
-This will build a file tree under build/dreamplug, representing the
-contents of a root file system, then that content will be copied to the stick.
+## Running from a USB Stick
-Move the USB stick to the DreamPlug, obtain a serial console, and hit reset.
-A good way to access the serial console (actually USB serial emulation
-provided by the optional JTAG dongle), is to use 'screen', like so:
+Move the USB stick to the DreamPlug, obtain a serial console, and hit reset. A
+good way to access the serial console (actually USB serial emulation provided by
+the optional JTAG dongle), is to use 'screen', like so:
screen /dev/ttyUSB0 115200
-Interrupt the boot by pressing a key during the autoboot countdown, and type
-the following to boot from the USB stick:
+Interrupt the boot by pressing a key during the autoboot countdown, and type the
+following to boot from the USB stick:
setenv bootcmd '${x_bootcmd_usb}; ${x_bootcmd_kernel}; ${x_bootcmd_initrd}; setenv bootargs ${x_bootargs} ${x_bootargs_root}; bootm 0x6400000 0x6900000;'
setenv x_bootcmd_kernel fatload usb 2 0x6400000 uImage
@@ -48,21 +102,22 @@ the following to boot from the USB stick:
The system should boot to a login prompt, using only the bits on the stick.
-The default root password is 'freedom'
+The default root password is 'freedom'. The normal user is "fbx" and the
+password is "frdm".
- - - - -
-To set things up to boot from the internal microSD card, once you're logged
-into the system booted from root on USB stick you can use:
+To set things up to boot from the internal microSD card, once you're logged into
+the system booted from root on USB stick you can use:
/sbin/copy2dream
-Note that if you don't have a reasonable system date and time set in the
+Note that if you don't have a reasonable system date and time set in the
DreamPlug before running this command, you may see a long stream of warnings
from tar about timestamps being in the future. It is safe to ignore these.
On reboot, you may want to interrupt the boot and type the following to ensure
-you boot from the internal microSD by default. This bootcmd line elides the
+you boot from the internal microSD by default. This bootcmd line elides the
time-consuming attempts to boot grom gigE, which makes boot go much faster:
setenv bootcmd '${x_bootcmd_usb}; ${x_bootcmd_kernel}; ${x_bootcmd_initrd}; setenv bootargs ${x_bootargs} ${x_bootargs_root}; bootm 0x6400000 0x6900000;'