Added instructions to get the sources with submodules

This commit is contained in:
Michel-FK 2019-03-24 23:41:16 +01:00
parent 4c4f5b8001
commit b176815d4d
2 changed files with 26 additions and 3 deletions

View File

@ -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 <Funkey directory>
Then enter into the created directory:
$ cd <Funkey directory>
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 directory>/FunKey/output/images/sdcard.img of=/dev/sdX
$ sudo dd if=<Funkey directory>/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:

View File

@ -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 <Funkey directory>
Then enter into the created directory:
$ cd <Funkey directory>
How to build it
===============