readme.txt 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. # FunKey
  2. Intro
  3. =====
  4. This directory contains a buildroot-based external configuration for
  5. building the FunKey.
  6. How to get it
  7. ===============
  8. Clone the FunKey OS repository and the required submodules from
  9. BitBucket:
  10. $ git clone --recurse-submodules git@bitbucket.org:keymu2/funkey-os.git <Funkey directory>
  11. Then enter into the created directory:
  12. $ cd <Funkey directory>
  13. How to build it
  14. ===============
  15. Configure Buildroot
  16. -------------------
  17. There is only one Funkey defconfig files in Buildroot:
  18. $ ./fun funkey_defconfig
  19. Build the rootfs
  20. ----------------
  21. Note: you will need to have access to the network, since Buildroot
  22. will download the packages' sources.
  23. You may now build your FunKey with:
  24. $ ./have fun
  25. (This may take a while, consider getting yourself a coffee ;-) )
  26. Result of the build
  27. -------------------
  28. After building, you should obtain this tree:
  29. FunKey/output/images/
  30. +-- boot.scr
  31. +-- boot.vfat
  32. +-- rootfs.ext2
  33. +-- rootfs.ext4 -> rootfs.ext2
  34. +-- sdcard.img
  35. +-- sun8i-v3s-funkey.dtb
  36. +-- u-boot.bin
  37. +-- u-boot-sunxi-with-spl.bin
  38. `-- uImage
  39. How to write the SD card
  40. ========================
  41. Once the build process is finished you will have an image called
  42. "sdcard.img" in the FunKey/output/images/ directory.
  43. Copy the bootable "sdcard.img" onto an SD card with "dd":
  44. $ sudo dd if=<Funkey directory>/FunKey/output/images/sdcard.img of=/dev/sdX
  45. Alternatively, you can use the Etcher graphical tool to burn the image
  46. to the SD card safely and on any platform:
  47. https://etcher.io/
  48. Once the SD card is burned, insert it into your FunKey board, and
  49. power it up. Your new system should come up now and start a console on
  50. the UART0 serial port.