2018-02-25 19:07:30 +00:00
|
|
|
# FunKey
|
|
|
|
|
|
|
|
|
|
Intro
|
|
|
|
|
=====
|
|
|
|
|
|
2019-03-24 22:24:40 +00:00
|
|
|
This directory contains a buildroot-based external configuration for
|
2018-02-25 19:07:30 +00:00
|
|
|
building the FunKey.
|
|
|
|
|
|
2019-03-24 22:41:16 +00:00
|
|
|
How to get it
|
|
|
|
|
===============
|
|
|
|
|
|
2020-11-05 13:59:58 +00:00
|
|
|
Clone the FunKey OS repository from Github:
|
2019-03-24 22:41:16 +00:00
|
|
|
|
2020-11-05 13:55:50 +00:00
|
|
|
$ git clone https://github.com/FunKey-Project/FunKey-OS.git <Funkey directory>
|
2019-03-24 22:41:16 +00:00
|
|
|
|
|
|
|
|
Then enter into the created directory:
|
|
|
|
|
|
|
|
|
|
$ cd <Funkey directory>
|
|
|
|
|
|
2018-02-25 19:07:30 +00:00
|
|
|
How to build it
|
|
|
|
|
===============
|
|
|
|
|
|
2020-11-05 13:55:50 +00:00
|
|
|
Build the disk image & firmware update files
|
|
|
|
|
--------------------------------------------
|
2018-02-25 19:07:30 +00:00
|
|
|
|
2020-11-05 13:55:50 +00:00
|
|
|
Note: you will need to have access to the network, since buildroot
|
2018-02-25 19:07:30 +00:00
|
|
|
will download the packages' sources.
|
|
|
|
|
|
2019-03-24 22:24:40 +00:00
|
|
|
You may now build your FunKey with:
|
2018-02-25 19:07:30 +00:00
|
|
|
|
2020-11-05 13:55:50 +00:00
|
|
|
$ make
|
2018-02-25 19:07:30 +00:00
|
|
|
|
|
|
|
|
(This may take a while, consider getting yourself a coffee ;-) )
|
|
|
|
|
|
|
|
|
|
Result of the build
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
After building, you should obtain this tree:
|
|
|
|
|
|
2020-11-05 13:55:50 +00:00
|
|
|
images/
|
|
|
|
|
+-- FunKey-rootfs-X.Y.fwu
|
|
|
|
|
`-- sdcard.img
|
2018-02-25 19:07:30 +00:00
|
|
|
|
|
|
|
|
How to write the SD card
|
|
|
|
|
========================
|
|
|
|
|
|
|
|
|
|
Once the build process is finished you will have an image called
|
2020-11-05 13:55:50 +00:00
|
|
|
"sdcard.img" in the images/ directory.
|
2018-02-25 19:07:30 +00:00
|
|
|
|
|
|
|
|
Copy the bootable "sdcard.img" onto an SD card with "dd":
|
|
|
|
|
|
2020-11-05 13:55:50 +00:00
|
|
|
$ sudo dd if=<Funkey directory>/images/sdcard.img of=/dev/sdX
|
2018-02-25 19:07:30 +00:00
|
|
|
|
2019-03-24 22:24:40 +00:00
|
|
|
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.
|
