Mirror of funkey-project/funkey-os@github.com - OS for the FunKey kickstarter-funded handheld games console.
Go to file
Michel-FK 8c7a3ed3f3 update README file
Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
2020-11-05 14:55:50 +01:00
FunKey add swupdate to rootfs too 2020-11-05 14:46:49 +01:00
Recovery add swupdate to rootfs too 2020-11-05 14:46:49 +01:00
buildroot@d8082db677 bump buildroot to 2020-02.7 2020-11-05 11:37:33 +01:00
docker recovery build 2020-10-20 23:26:28 +02:00
.gitignore recovery build 2020-10-20 23:26:28 +02:00
.gitmodules Removed obsolete submodules 2020-06-06 22:23:19 +02:00
Makefile add swupdate to rootfs too 2020-11-05 14:46:49 +01:00
README.md update README file 2020-11-05 14:55:50 +01:00
genimage.cfg add swap partition 2020-11-02 16:49:47 +01:00

README.md

FunKey

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 Github:

$ git clone https://github.com/FunKey-Project/FunKey-OS.git

Then enter into the created directory:

$ cd

How to build it

Build the disk image & firmware update files

Note: you will need to have access to the network, since buildroot will download the packages' sources.

You may now build your FunKey with:

$ make

(This may take a while, consider getting yourself a coffee ;-) )

Result of the build

After building, you should obtain this tree:

images/
+-- FunKey-rootfs-X.Y.fwu
`-- sdcard.img

How to write the SD card

Once the build process is finished you will have an image called "sdcard.img" in the images/ directory.

Copy the bootable "sdcard.img" onto an SD card with "dd":

$ sudo dd if=/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:

https://etcher.io/

Once the SD card is burned, insert it into your FunKey board, and power it up. Your new system should come up now and start a console on the UART0 serial port.