aboutsummaryrefslogtreecommitdiff
path: root/ci
diff options
context:
space:
mode:
authorFelix (xq) Queißner <git@mq32.de>2020-06-29 19:21:05 +0200
committerFelix (xq) Queißner <git@mq32.de>2020-06-29 19:21:05 +0200
commitdcba6f90718d3f009380ad2b2994790866b881e2 (patch)
tree208f7024329663144f252b65f0db560c08e82ee2 /ci
parentae85907fd307651dc52c3cf7d439c04882c24562 (diff)
downloadkristall-dcba6f90718d3f009380ad2b2994790866b881e2.tar.gz
Adds CI readme.
Diffstat (limited to 'ci')
-rw-r--r--ci/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/ci/README.md b/ci/README.md
new file mode 100644
index 0000000..27444a4
--- /dev/null
+++ b/ci/README.md
@@ -0,0 +1,23 @@
+# Build Instructions for AppImage
+
+This folder contains a `Dockerfile` to create a AppImage for Kristall.
+
+Requirements:
+- docker
+- docker-compose
+
+Build process:
+```sh
+docker build --tag kristall-ci:1.0 .
+docker-compose up
+```
+
+This will create two files in the output folder:
+- `kristall`
+ The raw binary output
+- `Kristall-nightly-x86_64.AppImage`
+ The *AppImage* build of Kristall, should run on any
+
+Result was tested on:
+- Gentoo / Kernel 5.4.48
+- Arch Linux / Kernel 5.7.6 \ No newline at end of file