aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoshua M. Boniface <joshua@boniface.me>2024-03-18 12:39:32 -0400
committerJoshua M. Boniface <joshua@boniface.me>2024-03-18 12:39:32 -0400
commit18d74d5fa3b874f11ce8027c26235a48729450f7 (patch)
tree12f8c9fd5c8670aa8215a1ca07ca672bc27e04b0
parentRemove incorrect docker ref (diff)
downloadjellyfin-packaging-18d74d5fa3b874f11ce8027c26235a48729450f7.tar.gz
jellyfin-packaging-18d74d5fa3b874f11ce8027c26235a48729450f7.tar.bz2
jellyfin-packaging-18d74d5fa3b874f11ce8027c26235a48729450f7.zip
Add examples to quickstart
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
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) `<jellyfin_version>-<build_arch>`.
+#### Examples
+
+Build an `amd64` Docker image:
+
+```
+./build.py auto docker amd64 --local
+```
+
## Design
Inside this repository are 7 major components:
bgstack15