funkey/FunKey-Project.github.io
1
0
Fork 0
mirror of https://github.com/FunKey-Project/FunKey-Project.github.io.git synced 2026-03-19 18:32:51 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

fill-in build_system section

Browse Source 
Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
This commit is contained in:
Michel-FK
2021-02-21 12:13:02 +01:00
parent 75df708565
commit 8c296e241e
8 changed files with 363 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/developer_guide/tutorials/build_system/compile_distribution.md
View File

@@ -1,4 +1,65 @@
## On a Physical Machine / In a Virtual Machine
You may now build your FunKey with:
```bash
$ make sdk all
```
This may take a while (~1h30), so consider getting yourself
a cup, a glass or a bottle of your favorite beverage ;-)
<ins>Note</ins>: you will need to have access to the network, since
buildroot will download the package sources.
After building, you should obtain the SD Card image
`FunKey-sdcard-X.Y.Z.img`, the SDK file `FunKey-sdk-X.Y.Z.tar.gz` and
the firmware update file `FunKey-rootfs-X.Y.fwu` in the `images`
directory.
## In a Docker Container
You may now build your FunKey with:
```bash
$ docker run --name funkey-os funkeyproject/funkey-os
```
Or alternatively, you can run it in the background with:
```bash
$ docker run -d --name funkey-os funkeyproject/funkey-os
```
If you launch it in the background, you can still follow what is going
on with either:
```bash
$ docker top funkey-os
```
Or:
```bash
$ docker logs funkey-os
```
This may take a while (~1h30), so consider getting yourself a cup, a
glass or a bottle of your favorite beverage ;-)
<ins>Note</ins>: you will need to have access to the network, since
buildroot will download the package sources.
After building, you can copy the SD Card image `sdcard.img`, the SDK
file `FunKey-sdk-X.Y.tar.gz` and the firmware update file
`FunKey-rootfs-X.Y.fwu` from the container into the host current
directory:
```bash
$ mkdir images
$ docker cp funkey-os:/home/funkey/FunKey-OS/images/FunKey-sdcard-X.Y.Z.img images/
$ docker cp funkey-os:/home/funkey/FunKey-OS/images/FunKey-sdk-X.Y.Z.tar.gz images/
$ docker cp funkey-os:/home/funkey/FunKey-OS/images/FunKey-rootfs-X.Y.Z.fwu images/
```
--8<--
includes/glossary.md
--8<--
--8<--