diff --git a/scripts/README-SDCard-write b/scripts/README-SDCard-write new file mode 100644 index 0000000..debe19e --- /dev/null +++ b/scripts/README-SDCard-write @@ -0,0 +1,68 @@ +This folder contains a collection of scripts to write images to (SD)cards. A +simple GUI was implemented to make selections easy. This GUI is based on +'dialog' [1] which should be part of common packages in most distros. + + +There are three type of scripts: + +1. card-part: These type of scripts create partitions on the card as the + bootloaders expect them. This type of scripts are necessary only for + machines whose board support layer still builds images in 'old style' + e.g rootfs as *.tar.bz2). +2. card-write: These type of scripts write complete images (bootloader/ + devicetrees/kernel/rootfs) onto card. + Machine defaults can be overriden by setting variables + 'Machine' / 'FindString' - see include/card-helpers.inc + function StartCardWrite. +3. card-kernel-write: This family of scripts just overwrite kernel, devicetrees + and kernel modules on cards with image installed. These scripts are extremly + helpful for testing kernel/devicetree modififations or just updating kernel + on precious (=many settings applied / full of userdata) images. + Machine defaults can be overriden by setting variables + 'Machine' / 'KernelImageType' / 'FindString' - see include/card-helpers.inc + function StartCardKernelWrite. + +To reduce the GUI-dialogs displayed or avoid them completely all scripts can be +called with the following parameters + +1. Card device path e.g '/dev/sdc' +2. Source file to be written (either rootfs or kernel link with abiversion) +3. su / sudo selection: Pass '1' for su or '2' for sudo + + +Script structure: + +1. include/*helper.inc: These script snippets are included by other scripts and + contain useful functions to be re-used by other scripts. +2. include/machine-*.inc: All machine specific definitions and function + overrides are found in these files. + The following variables should be set within them: + * DEFAULT_MACHINE_FAMILY: This variable is used to find machine specific + deploy-dir containing kernel/rootfs... + o Example contents are: '*imx*' / 'raspberrypi*'. + o Defaults can be overriden by calling scripts with: + Machine=