-
Notifications
You must be signed in to change notification settings - Fork 0
Setup
Guidelines on setting up the ALAN working environment.
Table of Contents
I'm trying to provide some helpful instructions on how to setup the working enviroment to build Alan under different OSs, in particular under Windows.
I'll cover detailed setup instructions for Windows in separate pages of the Wiki, this page provides an OS-agnostic overview of the required tools.
This page provides an OS-agnostic overview of the required tools, I'll cover detailed setup instructions for Windows in a separate Wiki page:
These are the required tools and dependencies for all OSs:
CGreen is a cross-language unit testing and mocking framework for C and C++. The Alan project requires it for testing, although it can be disabled in the build process by using make CGREEN=no.
The Emacs editor is required in order to interact with Xrefactory, which is only available as an Emacs tool. If you're not going to use Xrefactory than you can just use any editor of your choice.
Xrefactory (aka Xref, X-ref and Xref-Speller) is a very old tool. For details on its history, see Thomas explanation on his personal fork of Xref:
Thomas fork of Xrefactory contains an updated version of the tool, so probably you should install his copy instead of the original.
The following files in the Alan repository provide guidelines on the requirements for building Alan under different OSs:
Alan IF official links: Alan Website | Alan Wiki | Source code on GitHub