Skip to content

Commit 500c9de

Browse files
Michel-FKMichel-FK
committed
FunKey-OS Release 1.00
Signed-off-by: Michel-FK <[email protected]>
1 parent 20e7d07 commit 500c9de

File tree

9 files changed

+42
-59
lines changed

9 files changed

+42
-59
lines changed

‎FunKey/board/funkey/rootfs-overlay/etc/issue‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
|___| |_____|__|__||__|\__||_____|___ |
66
FUN ON A KEYCHAIN |_____|
77
-----------------------------------------------------
8-
Version 0.98
8+
Version 1.00
99
-----------------------------------------------------
1010

‎FunKey/board/funkey/rootfs-overlay/etc/os-release‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
NAME="FunKey-OS"
2-
VERSION="0.98 (Khaki Kitten)"
2+
VERSION="1.00 (Khaki Kitten)"
33
ID=funkey
44
ID_LIKE=buildroot
5-
PRETTY_NAME="FunKey-OS 0.98"
6-
VERSION_ID="0.98"
5+
PRETTY_NAME="FunKey-OS 1.00"
6+
VERSION_ID="1.00"
77
HOME_URL="https://www.funkey-project.com/"
88
SUPPORT_URL="https://www.funkey-project.com/"
99
BUG_REPORT_URL="https://www.funkey-project.com/"

‎FunKey/board/funkey/rootfs-overlay/etc/sw-versions‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
rootfs 0.98
1+
rootfs 1.00

‎README.md‎

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -107,58 +107,41 @@ After building, you should obtain the SD Card image `sdcard.img` and the firmwar
107107
When using a Docker container, all the prerequisites are automatically installed.
108108

109109
### How to get the sources
110-
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:
110+
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:
111111

112112
```bash
113113
$ mkdir <FunKey directory>
114114
$ cd <FunKey directory>
115115
$ wget https://raw.githubusercontent.com/FunKey-Project/FunKey-OS/master/docker/Dockerfile
116-
$ wget https://raw.githubusercontent.com/FunKey-Project/FunKey-OS/master/docker/apt-sources.list
117116
```
118117
You must then build the docker image (don't forget the final dot!):
119118
```bash
120119
$ docker build -t funkey-project/funkey-os .
121120
```
122121

123-
You are now ready to run interactively a new container based on this docker image:
124-
```bash
125-
$ docker run -d -it --name funkey-os funkey-project/funkey-os
126-
```
127-
You can then clone the FunKey OS repository from Github in this brand new container:
128-
129-
```bash
130-
$ git clone https://github.com/FunKey-Project/FunKey-OS.git <FunKey directory>
131-
```
132-
Then enter into the created directory:
133-
134-
```bash
135-
$ cd <FunKey directory>
136-
```
137-
138122
### Build the disk image & firmware update files
139123
You may now build your FunKey with:
140124

141125
```bash
142-
$ make
126+
$ docker run -d -name funkey-os funkey-project/funkey-os
143127
```
144128
This may take a while, consider getting yourself a cup or glass of your favorite beverage ;-)
145129

146130
<ins>Note</ins>: you will need to have access to the network, since buildroot will download the package sources.
147131

148132
### Result of the build
149-
After building, you can exit the container by typing Ctrl+D.
150-
151-
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:
133+
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:
152134
```bash
153-
$ docker cp funkey-os:/home/funkey/<FunKey directory>/images/sdcard.img ./
154-
$ docker cp funkey-os:/home/funkey/<FunKey directory>/images/FunKey-rootfs-X.Y.fwu ./
135+
$ mkdir images
136+
$ docker cp funkey-os:/home/funkey/<FunKey directory>/images/sdcard.img images/
137+
$ docker cp funkey-os:/home/funkey/<FunKey directory>/images/FunKey-rootfs-X.Y.fwu images/
155138
```
156139

157140
## How to write to the SD card
158-
You can copy the bootable "sdcard.img" onto an SD card using "dd":
141+
You can copy the bootable `images/sdcard.img` onto an SD card using "dd":
159142

160143
```bash
161-
$ sudo dd if=sdcard.img of=/dev/sdX
144+
$ sudo dd if=images/sdcard.img of=/dev/sdX
162145
```
163146
<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!
164147

@@ -170,3 +153,13 @@ https://www.balena.io/etcher/
170153
Once the SD card is burnt, insert it into your FunKey S console slot, and
171154
power it up. Your new system should come up now and start a console on
172155
the UART0 serial port and display the retro game launcher on the graphical screen.
156+
157+
## How to update the FunKey S firmware
158+
It is possible to update a FunKey-S over USB:
159+
- Connect the FunKey S console to your host machine using the USB cable
160+
- From the retro-game launcher, press the **ON/OFF** button to access the menu
161+
- 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
162+
- Drag and drop the images/FunKey-rootfs-X.Y.fwu file into it
163+
- When finished, eject the USB mass storage from your host machine
164+
- Back on the FunKey S console, press the "**A**" key twice to eject the USB mass storage drive
165+
- 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

‎Recovery/board/funkey/rootfs-overlay/etc/issue‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
|___| |_____|__|__||__|\__||_____|___ |
66
FUN ON A KEYCHAIN |_____|
77
-----------------------------------------------------
8-
Version 0.991 (Recovery)
8+
Version 1.00 (Recovery)
99
-----------------------------------------------------
1010

‎Recovery/board/funkey/rootfs-overlay/etc/os-release‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
NAME="FunKey-OS Recovery"
2-
VERSION="0.991 (Khaki Kitten)"
2+
VERSION="1.00 (Khaki Kitten)"
33
ID=funkey-recovery
44
ID_LIKE=buildroot
5-
PRETTY_NAME="FunKey-OS Recovery 0.991"
6-
VERSION_ID="0.991"
5+
PRETTY_NAME="FunKey-OS Recovery 1.00"
6+
VERSION_ID="1.00"
77
HOME_URL="https://www.funkey-project.com/"
88
SUPPORT_URL="https://www.funkey-project.com/"
99
BUG_REPORT_URL="https://www.funkey-project.com/"

‎Recovery/board/funkey/rootfs-overlay/etc/sw-versions‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Recovery 0.991
1+
Recovery 1.00

‎docker/Dockerfile‎

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ LABEL \
88
# Setup environment
99
ENV DEBIAN_FRONTEND noninteractive
1010

11-
# This repository can be a bit slow at times. Don't panic...
12-
COPY apt-sources.list /etc/apt/sources.list
13-
1411
RUN \
1512
# Install dependencies
1613
# See https://buildroot.org/downloads/manual/manual.html#requirement
@@ -94,36 +91,33 @@ RUN \
9491
usermod -a -G sudo funkey && \
9592
echo "funkey:funkey" | chpasswd && \
9693
#
97-
# Create skeleton directories
98-
# mkdir -p /home/funkey/.buildroot-ccache \
99-
# /home/funkey/FunKey-OS/buildroot \
100-
# /home/funkey/FunKey-OS/FunKey/dl \
101-
# /home/funkey/FunKey-OS/FunKey/output/build \
102-
# /home/funkey/FunKey-OS/FunKey/output/host \
103-
# /home/funkey/FunKey-OS/FunKey/output/target && \
94+
# Clone the FunKey-OS repository
95+
git config --global url."https://91133a45ba476b7fc73c7b190dc597fa8f9c909d:@github.com/".insteadOf "https://github.com/" && \
96+
git clone https://github.com/Michel-FK/FunKey-OS.git /home/funkey/FunKey-OS && \
10497
#
10598
# Set file ownership
10699
chown -R funkey:funkey /home/funkey
107100

108101
# Set user
109102
USER funkey
110103

104+
# Set working directory
105+
WORKDIR /home/funkey/FunKey-OS
106+
111107
# Set environment
112108
ENV \
113109
HOME=/home/funkey \
114-
LC_ALL=en_US.UTF-8 \
115-
BR2_EXTERNAL=../FunKey \
116-
O=../FunKey/output
117-
118-
# Set working directory
119-
WORKDIR /home/funkey/
120-
#WORKDIR /home/funkey/FunKey-OS
110+
LC_ALL=en_US.UTF-8
121111

122112
# VOLUME ["/home/funkey/.buildroot-ccache", \
123113
# "/home/funkey/FunKey-OS/buildroot", \
124-
# "/home/funkey/FunKey-OS/FunKey/dl", \
125-
# "/home/funkey/FunKey-OS/FunKey/output/build", \
114+
# "/home/funkey/FunKey-OS/dowload", \
115+
# "/home/funkey/FunKey-OS/images", \
116+
# "/home/funkey/FunKey-OS/Recovery/output/build", \
117+
# "/home/funkey/FunKey-OS/Recovery/output/host", \
118+
# "/home/funkey/FunKey-OS/Recovery/output/target", \
126119
# "/home/funkey/FunKey-OS/FunKey/output/host", \
120+
# "/home/funkey/FunKey-OS/FunKey/output/build", \
127121
# "/home/funkey/FunKey-OS/FunKey/output/target"]
128122

129-
#CMD ["/bin/bash"]
123+
CMD ["/usr/bin/make", "-C", "/home/funkey/FunKey-OS"]

‎docker/apt-sources.list‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)