Current location

narf Source control manager Git

path: root/README
diff options
authorJames Valleroy <>2015-01-25 16:36:36 -0500
committerJames Valleroy <>2015-01-25 16:36:36 -0500
commit6a55ddbc951b56289edda50304bc65050cef0efb (patch)
tree6deaabf75f86467a12d1884dc9f0e87d300af773 /README
parentb98fc6653f018afce5dbef0fdcfb1194017f0744 (diff)
parent1aab0f71fc37be8172b87f56cc815bd45a57d4a7 (diff)
Merge pull request #8 from fonfon/documentation
Updated installation instructions
Diffstat (limited to 'README')
1 files changed, 10 insertions, 15 deletions
diff --git a/README b/README
index 642dfe4..c8aa59e 100644
--- a/README
+++ b/README
@@ -1,5 +1,3 @@
-<!-- -*- mode: markdown; mode: auto-fill; fill-column: 80 -*- -->
# Freedom-Maker - Bdale's Building Tools for the FreedomBox Project
Welcome to the FreedomBox! This project is the central hub of the FreedomBox
@@ -8,19 +6,15 @@ 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 use one of the pre-built systems we've already
- put together.
+1. Get a pre-built image via
+ There are images available for virtualbox, raspberry and dreamplug.
+ You also find the setup instructions in the Wiki.
- If you don't have a DreamPlug or don't know what one is, make sure
- to ask for a copy of the VirtualBox image. If you do have a
- DreamPlug, then 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 (not the
- USB) version.
+2. Create a VirtualBox image on your own: The "To Make It" section of this
+ document is all you need.
-2. If you want to change and build on it, you can use:
+3. Create an image for the dreamplug (or similar devices):
+ Read this document. You can use
A. A USB stick. This requires a JTAG, but doesn't require opening up the
DreamPlug, or,
@@ -297,7 +291,8 @@ you want to build.
Required for all images:
- # apt-get -y install git python-docutils mktorrent vmdebootstrap dosfstools
+ # apt-get -y install git python-docutils mktorrent vmdebootstrap \
+ dosfstools btrfs-tools
Required for VirtualBox:
@@ -314,7 +309,7 @@ Required for DreamPlug:
Now, fetch the git source of freedom-maker and build the image you want:
$ git clone freedom-maker
- $ make -C freedom-maker dreamplug-image raspberry-image virtualbox-image
+ $ make -C freedom-maker dreamplug raspberry virtualbox
If you only want one of the possible images of DreamPlug, RaspberryPi and
VirtualBox, remove the rest from the make command line. The images will show up