From 624c84e406a81d44d2c07b7e1bd2136b0b1d6b0e Mon Sep 17 00:00:00 2001
From: Ryan <ryan@helloryan.se>
Date: Sun, 9 Mar 2025 00:26:02 +0100
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5d5227e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Creatures - Build Environment
+
+This repository contains files to initialize a local Creatures build
+environment.
+
+The build environment contains a complete C++ environment and the build2
+build system.
+
+It also contains a Node environment and Yarn.
+
+## Creating the environment container
+
+The easiest way to initialize the environment is by running the create.sh
+file.
+
+## Aliases
+
+To simplify the usage of the build environment, copy the aliases.sh file to
+your ~/.bashrc.d/ directory.
+
+This will provide aliases for b, bdep, bpkg and yarn.
+
+## Building from scratch
+
+To build the environment from scratch, run the build.sh file.