From 0f08aefbc5c70a2d403bd786bba9c932c033e1b6 Mon Sep 17 00:00:00 2001
From: askiiart <askiiart@noreply.localhost>
Date: Tue, 25 Feb 2025 18:13:58 +0000
Subject: [PATCH] Add initial guidelines

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f330f7a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Guidelines
+
+- Scripts must use `set -euo pipefail`
+
+## Building
+
+- The directory for built programs is specified with the `COMPILED_DIR` environment variable, falling back to `/compiled`
+  - Built programs should be `.tar.zst` files placed in `$COMPILED_DIR/[package name]/`
+- Programs should be built on Debian, unless there's a specific reason not to.
+- There should be a `build` branch for building the program.
+
+## Packaging
+
+- The directory for built packages is specified with the `PACKAGES_DIR` environment variable, falling back to `/packages`
+  - They should be placed in `$PACKAGES_DIR/[package name]/`
+- Packages should be built on the distro they're for, unless there's a specific reason not to.
+- There should be a branch named after a distro for each distro it's for, e.g. `fedora` for Fedora.