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

FunKey-OS Release 1.00 

Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
This commit is contained in:
Michel-FK 2020-11-19 17:15:25 +01:00
parent 20e7d07012
commit 500c9ded7f
9 changed files with 42 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
FunKey/board/funkey/rootfs-overlay/etc/issue
View File

@ -5,6 +5,6 @@
|___| |_____|__|__||__|\__||_____|___ | |___| |_____|__|__||__|\__||_____|___ |
FUN ON A KEYCHAIN |_____| FUN ON A KEYCHAIN |_____|
----------------------------------------------------- -----------------------------------------------------
Version 0.98 Version 1.00
----------------------------------------------------- -----------------------------------------------------

6
FunKey/board/funkey/rootfs-overlay/etc/os-release
View File

@ -1,9 +1,9 @@
NAME="FunKey-OS" NAME="FunKey-OS"
VERSION="0.98 (Khaki Kitten)" VERSION="1.00 (Khaki Kitten)"
ID=funkey ID=funkey
ID_LIKE=buildroot ID_LIKE=buildroot
PRETTY_NAME="FunKey-OS 0.98" PRETTY_NAME="FunKey-OS 1.00"
VERSION_ID="0.98" VERSION_ID="1.00"
HOME_URL="https://www.funkey-project.com/" HOME_URL="https://www.funkey-project.com/"
SUPPORT_URL="https://www.funkey-project.com/" SUPPORT_URL="https://www.funkey-project.com/"
BUG_REPORT_URL="https://www.funkey-project.com/" BUG_REPORT_URL="https://www.funkey-project.com/"

2
FunKey/board/funkey/rootfs-overlay/etc/sw-versions
View File

@ -1 +1 @@
rootfs 0.98 rootfs 1.00

43
README.md
View File

@ -107,58 +107,41 @@ After building, you should obtain the SD Card image `sdcard.img` and the firmwar
When using a Docker container, all the prerequisites are automatically installed. When using a Docker container, all the prerequisites are automatically installed.
### How to get the sources ### How to get the sources
When using a Docker container, you must first get the FunKey-OS [Dockerfile](https://raw.githubusercontent.com/Michel-FK/FunKey-Project/master/docker/Dockerfile) and Debian [apt-sources.list](https://raw.githubusercontent.com/Michel-FK/FunKey-Project/master/docker/apt-sources.list) and put them into a separate directory: When using a Docker container, you must first get the FunKey-OS [Dockerfile](https://raw.githubusercontent.com/Michel-FK/FunKey-Project/master/docker/Dockerfile) and put it into a separate directory:
```bash ```bash
$ mkdir <FunKey directory> $ mkdir <FunKey directory>
$ cd <FunKey directory> $ cd <FunKey directory>
$ wget https://raw.githubusercontent.com/FunKey-Project/FunKey-OS/master/docker/Dockerfile $ wget https://raw.githubusercontent.com/FunKey-Project/FunKey-OS/master/docker/Dockerfile
$ wget https://raw.githubusercontent.com/FunKey-Project/FunKey-OS/master/docker/apt-sources.list
``` ```
You must then build the docker image (don't forget the final dot!): You must then build the docker image (don't forget the final dot!):
```bash ```bash
$ docker build -t funkey-project/funkey-os . $ docker build -t funkey-project/funkey-os .
``` ```
You are now ready to run interactively a new container based on this docker image:
```bash
$ docker run -d -it --name funkey-os funkey-project/funkey-os
```
You can then clone the FunKey OS repository from Github in this brand new container:
```bash
$ git clone https://github.com/FunKey-Project/FunKey-OS.git <FunKey directory>
```
Then enter into the created directory:
```bash
$ cd <FunKey directory>
```
### Build the disk image & firmware update files ### Build the disk image & firmware update files
You may now build your FunKey with: You may now build your FunKey with:
```bash ```bash
$ make $ docker run -d -name funkey-os funkey-project/funkey-os
``` ```
This may take a while, consider getting yourself a cup or glass of your favorite beverage ;-) This may take a while, consider getting yourself a cup or glass of your favorite beverage ;-)
<ins>Note</ins>: you will need to have access to the network, since buildroot will download the package sources. <ins>Note</ins>: you will need to have access to the network, since buildroot will download the package sources.
### Result of the build ### Result of the build
After building, you can exit the container by typing Ctrl+D. After building, you can copy the SD Card image `sdcard.img` and the firmware update file `FunKey-rootfs-X.Y.fwu` from the container into the host current directory:
You can copy the SD Card image `sdcard.img` and the firmware update file `FunKey-rootfs-X.Y.fwu` from the container into the host current directory:
```bash ```bash
$ docker cp funkey-os:/home/funkey/<FunKey directory>/images/sdcard.img ./ $ mkdir images
$ docker cp funkey-os:/home/funkey/<FunKey directory>/images/FunKey-rootfs-X.Y.fwu ./ $ docker cp funkey-os:/home/funkey/<FunKey directory>/images/sdcard.img images/
$ docker cp funkey-os:/home/funkey/<FunKey directory>/images/FunKey-rootfs-X.Y.fwu images/
``` ```
## How to write to the SD card ## How to write to the SD card
You can copy the bootable "sdcard.img" onto an SD card using "dd": You can copy the bootable `images/sdcard.img` onto an SD card using "dd":
```bash ```bash
$ sudo dd if=sdcard.img of=/dev/sdX $ sudo dd if=images/sdcard.img of=/dev/sdX
``` ```
<ins>Warning</ins>: Please make sure that */dev/sdX* device corresponds to your SD Card, otherwise you may wipe out one of your hard drive partitions! <ins>Warning</ins>: Please make sure that */dev/sdX* device corresponds to your SD Card, otherwise you may wipe out one of your hard drive partitions!
@ -170,3 +153,13 @@ https://www.balena.io/etcher/
Once the SD card is burnt, insert it into your FunKey S console slot, and Once the SD card is burnt, insert it into your FunKey S console slot, and
power it up. Your new system should come up now and start a console on power it up. Your new system should come up now and start a console on
the UART0 serial port and display the retro game launcher on the graphical screen. the UART0 serial port and display the retro game launcher on the graphical screen.
## How to update the FunKey S firmware
It is possible to update a FunKey-S over USB:
- Connect the FunKey S console to your host machine using the USB cable
- From the retro-game launcher, press the **ON/OFF** button to access the menu
- Using the **Up/Down** keys, select the "**MOUNT USB**" screen ad press the "**A**" key twice to mount the FunKey S on your machine as an USB mass storage drive
- Drag and drop the images/FunKey-rootfs-X.Y.fwu file into it
- When finished, eject the USB mass storage from your host machine
- Back on the FunKey S console, press the "**A**" key twice to eject the USB mass storage drive
- The FunKey S console will automatically detect the firmware update file and proceed with the update before returning to the retro game launcher screen once finished

2
Recovery/board/funkey/rootfs-overlay/etc/issue
View File

@ -5,6 +5,6 @@
|___| |_____|__|__||__|\__||_____|___ | |___| |_____|__|__||__|\__||_____|___ |
FUN ON A KEYCHAIN |_____| FUN ON A KEYCHAIN |_____|
----------------------------------------------------- -----------------------------------------------------
Version 0.991 (Recovery) Version 1.00 (Recovery)
----------------------------------------------------- -----------------------------------------------------

6
Recovery/board/funkey/rootfs-overlay/etc/os-release
View File

@ -1,9 +1,9 @@
NAME="FunKey-OS Recovery" NAME="FunKey-OS Recovery"
VERSION="0.991 (Khaki Kitten)" VERSION="1.00 (Khaki Kitten)"
ID=funkey-recovery ID=funkey-recovery
ID_LIKE=buildroot ID_LIKE=buildroot
PRETTY_NAME="FunKey-OS Recovery 0.991" PRETTY_NAME="FunKey-OS Recovery 1.00"
VERSION_ID="0.991" VERSION_ID="1.00"
HOME_URL="https://www.funkey-project.com/" HOME_URL="https://www.funkey-project.com/"
SUPPORT_URL="https://www.funkey-project.com/" SUPPORT_URL="https://www.funkey-project.com/"
BUG_REPORT_URL="https://www.funkey-project.com/" BUG_REPORT_URL="https://www.funkey-project.com/"

2
Recovery/board/funkey/rootfs-overlay/etc/sw-versions
View File

@ -1 +1 @@
Recovery 0.991 Recovery 1.00

34
docker/Dockerfile
View File

@ -8,9 +8,6 @@ LABEL \
# Setup environment # Setup environment
ENV DEBIAN_FRONTEND noninteractive ENV DEBIAN_FRONTEND noninteractive
# This repository can be a bit slow at times. Don't panic...
COPY apt-sources.list /etc/apt/sources.list
RUN \ RUN \
# Install dependencies # Install dependencies
# See https://buildroot.org/downloads/manual/manual.html#requirement # See https://buildroot.org/downloads/manual/manual.html#requirement
@ -94,13 +91,9 @@ RUN \
usermod -a -G sudo funkey && \ usermod -a -G sudo funkey && \
echo "funkey:funkey" | chpasswd && \ echo "funkey:funkey" | chpasswd && \
# #
# Create skeleton directories # Clone the FunKey-OS repository
# mkdir -p /home/funkey/.buildroot-ccache \ git config --global url."https://91133a45ba476b7fc73c7b190dc597fa8f9c909d:@github.com/".insteadOf "https://github.com/" && \
# /home/funkey/FunKey-OS/buildroot \ git clone https://github.com/Michel-FK/FunKey-OS.git /home/funkey/FunKey-OS && \
# /home/funkey/FunKey-OS/FunKey/dl \
# /home/funkey/FunKey-OS/FunKey/output/build \
# /home/funkey/FunKey-OS/FunKey/output/host \
# /home/funkey/FunKey-OS/FunKey/output/target && \
# #
# Set file ownership # Set file ownership
chown -R funkey:funkey /home/funkey chown -R funkey:funkey /home/funkey
@ -108,22 +101,23 @@ RUN \
# Set user # Set user
USER funkey USER funkey
# Set working directory
WORKDIR /home/funkey/FunKey-OS
# Set environment # Set environment
ENV \ ENV \
HOME=/home/funkey \ HOME=/home/funkey \
LC_ALL=en_US.UTF-8 \ LC_ALL=en_US.UTF-8
BR2_EXTERNAL=../FunKey \
O=../FunKey/output
# Set working directory
WORKDIR /home/funkey/
#WORKDIR /home/funkey/FunKey-OS
# VOLUME ["/home/funkey/.buildroot-ccache", \ # VOLUME ["/home/funkey/.buildroot-ccache", \
# "/home/funkey/FunKey-OS/buildroot", \ # "/home/funkey/FunKey-OS/buildroot", \
# "/home/funkey/FunKey-OS/FunKey/dl", \ # "/home/funkey/FunKey-OS/dowload", \
# "/home/funkey/FunKey-OS/FunKey/output/build", \ # "/home/funkey/FunKey-OS/images", \
# "/home/funkey/FunKey-OS/Recovery/output/build", \
# "/home/funkey/FunKey-OS/Recovery/output/host", \
# "/home/funkey/FunKey-OS/Recovery/output/target", \
# "/home/funkey/FunKey-OS/FunKey/output/host", \ # "/home/funkey/FunKey-OS/FunKey/output/host", \
# "/home/funkey/FunKey-OS/FunKey/output/build", \
# "/home/funkey/FunKey-OS/FunKey/output/target"] # "/home/funkey/FunKey-OS/FunKey/output/target"]
#CMD ["/bin/bash"] CMD ["/usr/bin/make", "-C", "/home/funkey/FunKey-OS"]

4
docker/apt-sources.list
View File

@ -1,4 +0,0 @@
# Latest just before 20200514T000000Z:
deb [check-valid-until=no] http://snapshot.debian.org/archive/debian/20200513T204247Z/ buster main
deb [check-valid-until=no] http://snapshot.debian.org/archive/debian/20200513T204247Z/ buster-updates main
deb [check-valid-until=no] http://snapshot.debian.org/archive/debian-security/20200513T204247Z/ buster/updates main