fix: missed \ and updated README (#34)

* fix: missed \

* fix: moved variables into table and added EXTRA_BOOT_PARAMS

* Update README.md

Co-authored-by: Robert Sturla <robertsturla@outlook.com>

---------

Co-authored-by: Robert Sturla <robertsturla@outlook.com>
This commit is contained in:
Noel Miller 2024-02-25 08:19:17 -06:00 committed by GitHub
parent ff58b2d122
commit e36da208a8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 23 deletions

View File

@ -29,28 +29,19 @@ docker run --rm --privileged --volume .:/isogenerator/output -e VERSION=39 -e IM
## Customizing ## Customizing
The following variables can be used to customize the create image. The following variables can be used to customize the create image.
- ARCH | Variable | Description | Default Value |
Architecture for image to build | ----------------- | -------------------------------------------------------- | ---------------------- |
Default Value: x86_64 | ARCH | Architecture for image to build | x86_64 |
- VERSION | VERSION | Fedora version of installer to build | 39 |
Fedora version of installer to build | IMAGE_REPO | Repository containing the source container image | ghcr.io/ublue-os |
Default Value: 39 | IMAGE_NAME | Name of the source container image | base-main |
- IMAGE_REPO | IMAGE_TAG | Tag of the source container image | *VERSION* |
Repository containing the source container image | EXTRA_BOOT_PARAMS | Extra params used by grub to boot the anaconda installer | \[empty\] |
Default Value: ghcr.io/ublue-os | VARIANT | Source container variant\* | Kinoite |
- IMAGE_NAME | WEB_UI | Enable Anaconda WebUI (experimental) | false |
Name of the source container image
Default Value: base-main Available options for VARIANT can be found by running `dnf provides system-release`.
- IMAGE_TAG Variant will be the third item in the package name. Example: `fedora-release-kinoite-39-34.noarch` will be kinoite
Tag of the source container image
Default Value: *VERSION*
- VARIANT
Source container variant
Available options can be found by running `dnf provides system-release`. Variant will be the third item in the package name. Example: `fedora-release-kinoite-39-34.noarch` will be kinonite
Default Value: Silverblue
- WEB_UI
Enable Anaconda WebUI
Default Value: false
## VSCode Dev Container ## VSCode Dev Container
There is a dev container configuration provided for development. By default it will use the existing container image available at `ghcr.io/ublue-os/isogenerator`, however, you can have it build a new image by editing `.devcontainer/devcontainer.json` and replacing `image` with `build`. `Ctrl+/` can be used to comment and uncomment blocks of code within VSCode. There is a dev container configuration provided for development. By default it will use the existing container image available at `ghcr.io/ublue-os/isogenerator`, however, you can have it build a new image by editing `.devcontainer/devcontainer.json` and replacing `image` with `build`. `Ctrl+/` can be used to comment and uncomment blocks of code within VSCode.

View File

@ -106,7 +106,7 @@ runs:
IMAGE_TAG=${{ inputs.IMAGE_TAG || inputs.VERSION }} \ IMAGE_TAG=${{ inputs.IMAGE_TAG || inputs.VERSION }} \
VARIANT=${{ inputs.VARIANT }} \ VARIANT=${{ inputs.VARIANT }} \
VERSION=${{ inputs.VERSION }} \ VERSION=${{ inputs.VERSION }} \
WEB_UI=${{ inputs.WEB_UI }} WEB_UI=${{ inputs.WEB_UI }} \
EXTRA_BOOT_PARAMS=${{ inputs.EXTRA_BOOT_PARAMS }} EXTRA_BOOT_PARAMS=${{ inputs.EXTRA_BOOT_PARAMS }}
- name: Create deploy.iso and generate sha256 checksum - name: Create deploy.iso and generate sha256 checksum