From daf23b9bb762ca00caec8023f90b5f857144e1ae Mon Sep 17 00:00:00 2001
From: penguin <penguin@epenguin.net>
Date: Wed, 24 Dec 2025 13:42:44 -0600
Subject: [PATCH] add readme

---
 README.org | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 README.org

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..a5c1bd5
--- /dev/null
+++ b/README.org
@@ -0,0 +1,50 @@
+#+title: Gentoo Utils
+
+* Getting Started
+
+Gentoo Utils must be compiled from source currently. See the compiling from source section for more information.
+
+* Development :development:contributing:
+
+There are two main avenues for development:
+- compiling normally using packages via portage
+- using the podman container
+
+** Development without using a podman container
+*** Install Build Prerequisites
+- dev-lang/rust-bin-9999
+- llvm-core/clang
+- llvm-core/lld
+- sys-process/parallel (Needed for =check.sh=)
+- dev-build/meson
+
+Install build deps:
+#+begin_src bash :noeval
+emerge -a dev-lang/rust-bin-9999 \
+    llvm-core/clang \
+    llvm-core/lld \
+    sys-process/parallel
+#+end_src
+
+Compiling this project currently requires using a patched meson. Install patched meson:
+#+begin_src bash :noeval
+EGIT_OVERRIDE_REPO_MESONBUILD_MESON=https://jturnerusa.dev/cgit/meson emerge -a =dev-build/meson-9999::gentoo
+#+end_src
+
+** Development using a podman container
+The podman image comes with all the tools required to compile gentoo-utils.
+
+Clone the repo
+#+begin_src bash :noeval
+git clone https://git.epenguin.net/gentoo-utils/gentoo-utils.git
+cd gentoo-utils
+#+end_src
+
+Run the check script:
+#+begin_src bash :noeval
+podman run --rm --userns=keep-id -v $PWD:/workspace git.epenguin.net/gentoo-utils/gentoo-utils:latest ./check.sh
+#+end_src
+
+
+* Resources
+pms-utils spec link