From c478804d89da818189913eee74ebdab330c3ca41 Mon Sep 17 00:00:00 2001
From: thislight <l1589002388@gmail.com>
Date: Sun, 14 Jul 2024 18:12:57 +0800
Subject: [PATCH] add READMEs

---
 README.md                   | 24 ++++++++++
 fedora-40-minimal/README.md | 64 +++++++++++++++++++++++++
 fedora-40/README.md         | 96 +++++++++++++++++++++++++++++++++++++
 3 files changed, 184 insertions(+)
 create mode 100644 fedora-40-minimal/README.md
 create mode 100644 fedora-40/README.md

diff --git a/README.md b/README.md
index e69de29..ce269b0 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,24 @@
+# Action-ready Container Images
+
+These images is cached on action runner machines and is able to run most of the actions.
+
+| Name | OS and Distro | Description | Note |
+| - | - | - | - |
+| `fedora:40` | Fedora 40 | [Description](./fedora-40/README.md) | |
+| `fedora-minimal:40` | Fedora 40 | [Description](./fedora-40-minimal/README.md) | |
+
+## FAQ
+
+### Can I see those images as alternatives of GitHub's [actions/runner-images]?
+
+Yes, mostly. We are working on catching up the software list on their repo, and many tools are already included in our images, but be attention that we took a different approach to install softwares (at least for now).
+
+### Can all GitHub Actions or Forgejo Actions can be run on those images?
+
+Well, not quite. Those images are "action-ready" because bunch of tools used by actions, like NodeJS, are preinstalled in the image. It depends on the action to support the tools and the distro.
+
+### What's the difference between the `-minimal` version and the without?
+
+The minimal versions are configured with only basic toolset to run the actions. The images without `-minimal` include more tools to be used directly for end users.
+
+The minimal versions is only recommended for building custom images. They are smaller and configured the container environment. In fact, the regular versions are composed from the minimal versions.
diff --git a/fedora-40-minimal/README.md b/fedora-40-minimal/README.md
new file mode 100644
index 0000000..1918b6c
--- /dev/null
+++ b/fedora-40-minimal/README.md
@@ -0,0 +1,64 @@
+# fedora-minimal:40
+
+```yaml
+container:
+  image: code.lightstands.xyz/standcoded/fedora-minimal:40
+```
+
+## Included Softwares
+
+### General
+
+- coreutils
+- bash
+- aria2
+- jq
+- yq
+- zstd
+- brotil
+- sqlite
+
+### Version Control
+
+- git
+- git-lfs
+- git-ftp
+
+### Container Management
+
+- podman
+- buildah
+- fuse-overlayfs
+
+### NodeJS
+
+- nodejs
+- nodejs-npm
+
+### Python
+
+- python3
+- python3-devel
+- python3-pip
+- pipx
+
+### Perl
+
+- perl
+- perl-CPAN
+
+### Ruby
+
+- ruby
+- rubygems
+
+### C
+
+- clang
+- gcc
+
+## Additional Configuration
+
+### Building Container Images
+
+This images configured buildah to be correctly run under a container. You can use [The workflow of this project](./.forgejo/workflows/build-fedora-40.yml) as an example.
diff --git a/fedora-40/README.md b/fedora-40/README.md
new file mode 100644
index 0000000..c0392b8
--- /dev/null
+++ b/fedora-40/README.md
@@ -0,0 +1,96 @@
+# fedora:40
+
+```yaml
+container:
+  image: code.lightstands.xyz/standcoded/fedora:40
+```
+
+## Included Softwares
+
+### General
+
+- coreutils
+- bash
+- aria2
+- jq
+- yq
+- zstd
+- brotil
+- sqlite
+
+- sqlite-devel
+- binutils
+
+### Version Control
+
+- git
+- git-lfs
+- git-ftp
+
+### Container Management
+
+- podman
+- buildah
+- fuse-overlayfs
+- qemu-user-static
+- qemu-user-binfmt
+
+### NodeJS
+
+- nodejs
+- nodejs-npm
+
+- nodejs-devel
+
+### Python
+
+- python3-devel
+- python3-pip
+- pipx
+
+- poetry
+
+### Perl
+
+- perl
+- perl-CPAN
+
+- perl-devel
+
+### Ruby
+
+- ruby
+- rubygems
+
+- ruby-devel
+
+### C
+
+- clang
+- gcc
+- bison
+- flex
+
+- "C Development Tools and Libraries"
+
+### PHP
+
+- php
+- php-devel
+- composer
+
+### Java
+
+| Version | Packages |
+| - | - |
+| 1.8.0 | java-1.8.0-openjdk, java-1.8.0-openjdk-devel |
+| 11 | java-11-openjdk, java-11-openjdk-devel |
+| 17 | java-17-openjdk, java-17-openjdk-devel |
+| 21 | java-21-openjdk, java-21-openjdk-devel |
+
+## Additional Configuration
+
+### Building Container Images
+
+This images configured buildah to be correctly run under a container. You can use [The workflow of this project](./.forgejo/workflows/build-fedora-40.yml) as an example.
+