From 18d74d5fa3b874f11ce8027c26235a48729450f7 Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Mon, 18 Mar 2024 12:39:32 -0400 Subject: Add examples to quickstart --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index dcc24e7..6b93bad 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,32 @@ If you want a non-Docker image output (`.deb`, `tar`/`zip` archive, etc.) follow 1. The output binaries will be in the `out/` directory, ready for use. The exact format varies depending on the build type, and can be found, for each archive-based platform, as the values to the `archivetypes` key in the `build.yaml` configuration file. +#### Examples + +Build `.deb` packages for Debian 12 "Bookworm" amd64: + +``` +./build.py auto debian amd64 12 +``` + +Build Linux `.tar.xx` archives for arm64-musl: + +``` +./build.py auto linux arm64-musl +``` + +Build Windows `.zip` for `amd64`: + +``` +./build.py auto windows amd64 +``` + +Build a .NET portable `.zip`: + +``` +./build.py auto portable +``` + ### Docker Image Platform If you want a Docker image output follow this process: @@ -92,6 +118,14 @@ If you want a Docker image output follow this process: 1. The output container image(s) will be present in your `docker image ls` as `jellyfin/jellyfin` with the tag(s) `-`. +#### Examples + +Build an `amd64` Docker image: + +``` +./build.py auto docker amd64 --local +``` + ## Design Inside this repository are 7 major components: -- cgit