Start working on the READMEs

Author: alexiri

.github/README.md

@@ -0,0 +1,46 @@
+# Purpose
+
+This repository is a template repository for generating Atomic AlmaLinux respins.
+
+[Create a new repository](https://github.com/new?template_name=atomic-respin-template&template_owner=AlmaLinux)
+using this template to get started! Once that's done, there you can follow [the instructions](README.md) of your
+newly-created repository to start customizing your image.
+
+# Contributing
+
+We welcome contributions to all parts of the AlmaLinux project. If you'd like to get involved, please feel free to reach out through [the chat](https://chat.almalinux.org/almalinux/channels/sigatomic)!
+
+## Contributing - Code and Design
+
+This project is a template for starting new Atomic AlmaLinux respins.
+
+Before submitting code changes, please check if there are any open issues or pull requests that cover your proposal. If not, open an issue with a brief description and so you can discuss it with us first. This helps avoid duplicated work and ensures proposed changes align with project goals. This can be your anticipated workflow:
+
+- Create an issue describing your changes.
+- Await confirmation from contributors.
+- Fork the project.
+- Create a new branch for your feature or bug fix.
+- Add your code, documentation, etc.
+- Submit a pull request (PR). All PRs should target the `main` branch.
+
+After review and approval, the changes will be merged and deployed.
+
+## Reporting a Bug
+
+If you find a bug, please report it [here](issues)!
+
+## Requesting a Feature
+
+We're open to feature requests! Please follow this workflow:
+
+1. [Search existing issues](issues) to see if the feature has already been requested. If so, give it a thumbs up, +1, or a comment on your use-case.
+2. If no similar request exists, open a new issue. Please clearly explain why the feature is needed and provide a detailed use case.
+
+## Change Approval Process
+
+- Minor or cosmetic changes (typos, small style tweaks) can be reviewed and approved by any contributor with merge rights.
+- Larger changes should be agreed on as a SIG.
+
+# Getting help
+
+This repo is managed by the Atomic SIG. You can see how best to contact us in the [AlmaLinux wiki](https://wiki.almalinux.org/sigs/Atomic.html).

.github/workflows/initial_setup.yml

@@ -0,0 +1,27 @@
+---
+name: Initial Setup
+on: push
+
+permissions:
+  contents: write
+
+jobs:
+  start:
+    runs-on: ubuntu-latest
+    if: github.repository != 'AlmaLinux/atomic-respin-template'
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Run initial setup script
+        run: |
+          rm -rf \
+            .github/README.md \
+            .github/workflows/initial_setup.yml
+
+      - name: Commit changes
+        run: |
+          git config --global user.name 'GitHub Actions'
+          git config --global user.email '[email protected]'
+          git commit -a -m "Initial setup: remove template files"
+          git push

README.md

@@ -1 +1,64 @@
-# Image template repository
+# My Atomic AlmaLinux Respin
+
+Welcome to your brand-new Atomic AlmaLinux Respin!
+
+## Initial Setup
+
+### Set basic configuration
+
+In the ["Build image"](.github/workflows/build.yml) and ["Build ISOs"](.github/workflows/build-iso.yml) jobs, you'll
+find a `set-env` job where you can configure several things:
+    - `REGISTRY`: the registry to push your image to
+    - `REGISTRY_USER`: your username for this registry
+    - `IMAGE_PATH`: the path to your image
+    - `IMAGE_NAME`: your image's name
+    - `PLATFORMS`: a comma-separated list of platforms for which to build your image, like `"amd64,arm64"`
+
+If your registry is not Github (ie. `ghcr.io`) or you need a specific token to authenticate
+to your registry, search those two jobs for the line `REGISTRY_TOKEN: ${{ secrets.GITHUB_TOKEN }}`
+and replace the token for the appropriate secret.
+
+### Pick a base desktop image
+
+By default, this template configures the base image `quay.io/almalinuxorg/atomic-desktop-gnome:10`,
+which is [maintained](https://github.com/AlmaLinux/atomic-desktop) by the [AlmaLinux Atomic SIG](https://wiki.almalinux.org/sigs/Atomic.html).
+If you're not a fan of Gnome, you could also pick our KDE image (`quay.io/almalinuxorg/atomic-desktop-kde:10`).
+
+If you'd like to switch images, change the `FROM` line in the [Dockerfile](Dockerfile).
+
+### Setting up Cosign (Optional)
+
+If you'd like to sign your images using Cosign, here's what you need to do:
+
+1. Generate a cosign key:
+    `podman run --rm -it -v /tmp:/cosign-keys bitnami/cosign generate-key-pair`
+    Hit enter when asked for a private key password (that is, don't set a password). Once complete, you'll find the new key in `/tmp/cosign.{key,pub}` on your machine.
+
+2. Add `cosign.pub` to this repository as `/cosign.pub`, commit and push. Feel free to publish this file in other places too, it will be needed by everyone to verify the signature of the published images.
+
+3. In the github repo settings, go to "Secrets and variables" in the "Security" subsection and click on "Actions". Create a new Repository secret called `SIGNING_SECRET` and paste the contents of `cosign.key`. Save `cosign.key` in a secure location and delete it from your /tmp directory.
+
+## Customizing your respin
+
+Now that you're all set up, it's time for the fun part!
+
+### Adding files
+
+Any files you place in [`/files/system/`](files/system/) will be added to your image as is,
+preserving directory structure and file permissions. This is a simple mechanism for adding
+themes, backgrounds, etc.
+
+### Executing commands
+
+In [`/files/scripts/`](files/scripts/), you'll find a series of scripts that will be run
+during image creation. The `build.sh` script will first copy all the files from `/files/system/`
+into the image, then run the scripts in order, and finally run `cleanup.sh`. You can start by modifying [`10-base.sh`](files/scripts/10-base.sh)
+to suit your needs, and add more scripts as needed (always with the naming scheme `XX-whatever.sh`, where XX is a number).
+
+Do not modify `build.sh`, `cleanup.sh`, `90-signing.sh` or `91-image-info.sh` unless you
+understand what you're doing, those scripts should not need any customization under normal circumstances.
+
+### Build your new image
+
+Once you've added your files and scripts, commit your changes to let the CI build a new
+image for you. You can also run `make image` on your machine to build the image locally.