aboutsummaryrefslogtreecommitdiff
path: root/images/raspberry-pi-2/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'images/raspberry-pi-2/README.md')
-rw-r--r--images/raspberry-pi-2/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/images/raspberry-pi-2/README.md b/images/raspberry-pi-2/README.md
new file mode 100644
index 0000000..9d4ed0f
--- /dev/null
+++ b/images/raspberry-pi-2/README.md
@@ -0,0 +1,17 @@
+# Minimal Debian Image for the Raspberry Pi 2
+
+Makefile for building a bootable image that may be directly flashed to a memory card and used with a Raspberry Pi 2 Model B.
+
+The image contains a very basic Debian installation with an OpenSSH server. It is also self-expanding: on first boot, the partitions contained in the image will be expanded to fill the availale size of the memory card.
+
+## Build
+
+*Note: creating the image requires super user privileges because `chroot` is invoked as part of the build process.*
+
+Run the following to build a flashable image:
+
+ sudo make SSH_KEY_FILE=<path>
+
+where `SSH_KEY_FILE` is the absolute path of an SSH public key that will be used to login. SSH password login will be disabled, although the root account will nevertheless have its password set to "guest".
+
+This results in two image files `image.raw` and `image.bmap`. The former may be directly flashed to a memory card with a utility such as `dd`, whereas the latter is to be used with `bmaptool` (which promises perfomance increases of the flashing process).