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.