From b176815d4d8cfd622d06b03adcacd92a31e2970e Mon Sep 17 00:00:00 2001 From: Michel-FK Date: Sun, 24 Mar 2019 23:41:16 +0100 Subject: [PATCH] Added instructions to get the sources with submodules --- FunKey/board/funkey/readme.txt | 17 ++++++++++++++--- README.md | 12 ++++++++++++ 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/FunKey/board/funkey/readme.txt b/FunKey/board/funkey/readme.txt index 75aeb5a..74e959d 100644 --- a/FunKey/board/funkey/readme.txt +++ b/FunKey/board/funkey/readme.txt @@ -6,13 +6,25 @@ Intro This directory contains a buildroot-based external configuration for building the FunKey. +How to get it +=============== + +Clone the FunKey OS repository and the required submodules from +BitBucket: + + $ git clone --recurse-submodules git@bitbucket.org:keymu2/funkey-os.git + +Then enter into the created directory: + + $ cd + How to build it =============== Configure Buildroot ------------------- -There is only one FunKey defconfig files in Buildroot: +There is only one Funkey defconfig files in Buildroot: $ ./fun funkey_defconfig @@ -38,7 +50,6 @@ After building, you should obtain this tree: +-- boot.vfat +-- rootfs.ext2 +-- rootfs.ext4 -> rootfs.ext2 - +-- rootfs.tar +-- sdcard.img +-- sun8i-v3s-funkey.dtb +-- u-boot.bin @@ -53,7 +64,7 @@ Once the build process is finished you will have an image called Copy the bootable "sdcard.img" onto an SD card with "dd": - $ sudo dd if=/FunKey/output/images/sdcard.img of=/dev/sdX + $ sudo dd if=/FunKey/output/images/sdcard.img of=/dev/sdX Alternatively, you can use the Etcher graphical tool to burn the image to the SD card safely and on any platform: diff --git a/README.md b/README.md index 368c27b..74e959d 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,18 @@ Intro This directory contains a buildroot-based external configuration for building the FunKey. +How to get it +=============== + +Clone the FunKey OS repository and the required submodules from +BitBucket: + + $ git clone --recurse-submodules git@bitbucket.org:keymu2/funkey-os.git + +Then enter into the created directory: + + $ cd + How to build it ===============