Merge pull request #219 from numtide/terraform-docs

rework requirements page

docs/requirements.md

@@ -8,13 +8,27 @@
 
 ## Requirements
 
-- Source Machine:
-  - Can be any Linux or Mac computer with Nix installed, or a NixOS machine.
-- Destination Machine:
-  - Must be an x86-64 machine unless you are able to supply a `kexec` image for
-    your CPU type.
-  - If you're not using the option to boot from a Nixos installer image, it
-    must:
-    - Be running x86-64 Linux with kexec support . Most x86_64 Linux systems do
-      have kexec support.
-    - Have at least 1.5 GB of RAM, excluding swap.
+### Source Machine:
+
+1. **Supported Systems:**
+   - Linux or macOS computers with Nix installed.
+   - NixOS
+   - Windows systems using WSL2.
+
+2. **Nix Installation:** If Nix is not yet installed on your system, refer to
+   the [nix installation page](https://nixos.org/download#download-nix).
+
+### Destination Machine:
+
+1. **Direct Boot Option:**
+   - Must be already running a NixOS installer.
+
+2. **Alternative Boot Options:** If not booting directly from a NixOS installer
+   image:
+   - **Architecture & Support:** Must be operating on:
+     - x86-64 or aarch64 Linux systems with kexec support. Note: While most
+       x86-64 Linux systems support kexec, if you're using an architecture other
+       than those mentioned, you may need to specify a
+       [different kexec image](./howtos.md#using-your-own-kexec-image) manually.
+   - **Memory Requirements:**
+     - At least 1.5 GB of RAM (excluding swap space).

terraform/README.md

@@ -1,16 +1,21 @@
-# nixos-anywhere terraform modules
+# NixOS-Anywhere Terraform Modules Overview
 
-These terraform module can run nixos-anywhere from terraform to install nixos as
-well as deploying nixos afterwards.
+The NixOS-Anywhere Terraform modules allow you to use Terraform for installing
+and updating NixOS. It simplifies the deployment process by integrating
+nixos-anywhere functionality.
 
-See what each module does with examples by clicking on the terraform module in
-the following links below:
+Here's a brief overview of each module:
 
-- [all-in-one](all-in-one.md): Combines the install and nixos-rebuild module in
-  one interface to install NixOS with nixos-anywhere and than keep it up-to-date
-  with nixos-rebuild.
-- [install](install.md): Install NixOS with nixos-anywhere
-- [nixos-rebuild](nixos-rebuild.md): Update NixOS machine with nixos-rebuild on
-  a remote machine
-- [nix-build](nix-build.md): Small helper module to run do build a flake
-  attribute or attribute from a nix file.
+- **[All-in-One](all-in-one.md)**: This is a consolidated module that first
+  installs NixOS using nixos-anywhere and then keeps it updated with
+  nixos-rebuild. If you choose this, you won't need additional deployment tools
+  like colmena.
+- **[Install](install.md)**: This module focuses solely on installing NixOS via
+  nixos-anywhere.
+- **[NixOS-Rebuild](nixos-rebuild.md)**: Use this module to remotely update an
+  existing NixOS machine using nixos-rebuild.
+- **[Nix-Build](nix-build.md)**: This is a handy helper module designed to build
+  a flake attribute or an attribute from a nix file.
+
+For detailed information and usage examples, click on the respective module
+links above.

terraform/all-in-one.md

@@ -36,6 +36,8 @@ module "deploy" {
 }
 ```
 
+_Note:_ You need to mark scripts as executable (`chmod +x`)
+
 ### ./decrypt-ssh-secrets.sh
 
 ```