mirrors
/
FunKey-OS
mirror of https://github.com/FunKey-Project/FunKey-OS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update README file 

Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
This commit is contained in:
Michel-FK 2020-11-05 14:55:50 +01:00
parent 0f408f3b63
commit 8c7a3ed3f3
1 changed files with 11 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -10,9 +10,9 @@ How to get it
=============== ===============
Clone the FunKey OS repository and the required submodules from Clone the FunKey OS repository and the required submodules from
BitBucket: Github:
$ git clone --recurse-submodules https://github.com/FunKey-Project/FunKey-OS.git <Funkey directory> $ git clone https://github.com/FunKey-Project/FunKey-OS.git <Funkey directory>
Then enter into the created directory: Then enter into the created directory:
@ -21,22 +21,15 @@ Then enter into the created directory:
How to build it How to build it
=============== ===============
Configure Buildroot Build the disk image & firmware update files
------------------- --------------------------------------------
There is only one Funkey defconfig files in Buildroot: Note: you will need to have access to the network, since buildroot
$ ./fun funkey_defconfig
Build the rootfs
----------------
Note: you will need to have access to the network, since Buildroot
will download the packages' sources. will download the packages' sources.
You may now build your FunKey with: You may now build your FunKey with:
$ ./have fun $ make
(This may take a while, consider getting yourself a coffee ;-) ) (This may take a while, consider getting yourself a coffee ;-) )
@ -45,26 +38,19 @@ Result of the build
After building, you should obtain this tree: After building, you should obtain this tree:
FunKey/output/images/ images/
+-- boot.scr +-- FunKey-rootfs-X.Y.fwu
+-- boot.vfat `-- sdcard.img
+-- rootfs.ext2
+-- rootfs.ext4 -> rootfs.ext2
+-- sdcard.img
+-- sun8i-v3s-funkey.dtb
+-- u-boot.bin
+-- u-boot-sunxi-with-spl.bin
`-- zImage
How to write the SD card How to write the SD card
======================== ========================
Once the build process is finished you will have an image called Once the build process is finished you will have an image called
"sdcard.img" in the FunKey/output/images/ directory. "sdcard.img" in the images/ directory.
Copy the bootable "sdcard.img" onto an SD card with "dd": 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>/images/sdcard.img of=/dev/sdX
Alternatively, you can use the Etcher graphical tool to burn the image Alternatively, you can use the Etcher graphical tool to burn the image
to the SD card safely and on any platform: to the SD card safely and on any platform: