Installing bJou

Currently, the bJou compiler must be built from source. To compile bJou, ensure the following dependencies are met:

A C++ compiler new enough to support the C++11 standard
An installation of LLVM at least as new as version 4.0.0

LLVM can typically be found through a package manager such as apt, pacman, or homebrew.
Alternatively, the LLVM source code can be downloaded here and you can build it yourself.
Optional: It is recommended that you build LLVM with the lld linker tool enabled. If the version of LLVM used to build bJou comes with lld, it will be embedded into bJou and bJou will try to use it instead of the system linker.

Optional: If you have Google's TCMalloc installed, bJou will be built to use it for significant performance improvements.
- Read about it here.
- Get it as a part of gperftools.

If you have those dependencies met, you can grab a copy of bJou from GitHub:

$ git clone https://www.github.com/kammerdienerb/bJou

Using the Build Script

To build the project using the included build script, simply run:

$ ./build.sh

The build.sh script takes these additional arguments:

--build-type or just -b: accepts either "Debug" or "Release". Defaults to "Release".
--install-prefix or just -i: accepts a path in which to install bJou after it is built. Defaults to a system path like /usr or /usr/local.
--llvm-config or just -l: accepts a path to an llvm-config executable for the installation of LLVM you wish to use. If this flag is not provided, this will try to be determined automatically.

As an example, if you wanted to build a debug version of bJou in its own directory in your home directory with a version of LLVM also located in your home directory, you could do:

$ ./build.sh -b Debug --install-prefix ~/bjou --llvm-config ~/llvm/bin/llvm-config

Once bJou has successfully compiled, it can be installed to the previously specified install path:

$ ./install.sh

Using CMake Directly

bJou is a CMake-based project, so if you wish to have more control over the build, you can use the standard CMake build procedure to compile. The following variables can be changed:

LLVM_CONFIG: the path the the llvm-config executable.
BJOU_USE_COLOR: Turn on/off colored output from the bJou compiler.

To build, first navigate to the bJou project directory. Download an additional component, nolibc_syscall, and build it:

$ git clone https://www.github.com/kammerdienerb/nolibc_syscall

$ cd nolibc_syscall && make

Then, create a build directory:

$ mkdir /path/to/build/dir && cd /path/to/build/dir

Run CMake:

$ cmake /path/to/bjou

Build and install:

$ make && make install

Note: if you didn't build bJou with build.sh, DO NOT use install.sh.