Skip to content

Commit 4867d84

Browse files
committed
Improve readme [skip ci]
1 parent f526e63 commit 4867d84

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
11
# amiberry-docker-fedora-x86_64
22

3-
A Dockerfile which creates an image, with the requirements to build Amiberry for a Fedora `x86_64` platform.
3+
A Dockerfile which creates an image with all requirements to build Amiberry for a Fedora `x86_64` platform.
44

55
The image is based on Fedora:latest and includes all Amiberry dependencies (e.g. SDL2, SDL2-image, etc)
66

77
The full image is available on DockerHub: <https://hub.docker.com/repository/docker/midwan/amiberry-fedora-x86_64>
88

99
## Usage
1010

11-
`docker run --rm -it -v <dir-you-cloned-amiberry-into>:/build midwan/amiberry-fedora-x84_64:latest`
11+
```bash
12+
docker run --rm -it -v <dir-you-cloned-amiberry-into>:/build midwan/amiberry-fedora-x84_64:latest
13+
```
1214

13-
Then you can proceed to compile Amiberry as usual, e.g. `cmake -B build && cmake --build build`
15+
Then you can proceed to compile Amiberry as usual, e.g.:
16+
17+
```bash
18+
cmake -B build && cmake --build build
19+
```
20+
21+
## Building the image locally
22+
23+
To build the image yourself:
24+
25+
```bash
26+
docker build -t amiberry-fedora-x86_64:latest .
27+
```
28+
29+
## CI/CD
30+
31+
Images are automatically built and pushed to DockerHub via GitHub Actions on every push to `main` and on a daily schedule.

0 commit comments

Comments
 (0)