Add README

This commit is contained in:
R.Y.A.N 2025-03-09 00:26:02 +01:00
parent e61c2bb6ef
commit 624c84e406
Signed by: R.Y.A.N
GPG Key ID: 3BD93EABD1407B82

25
README.md Normal file
View File

@ -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.