The recommended way to set up your system and build Echo is to do the following.

Installing Dependencies

Prerequisites

1. Ensure you have Mercurial installed first.
2. Ensure you have access to the repositories.

On Unix-like platforms (Linux, BSD)

1. Clone the rEE Echo 3 Echo repository into the desired location:
   1. Open a Terminal and navigate to the directory where you want to clone into (e.g. ~/dev)
   2. In a browser, navigate to the rEE Echo 3 page and click the Clone button. This will show a URL to our server's copy of the project
   3. Run the command hg clone followed by the URL determined above; e.g. hg clone https://developer.emblem.net.au/source/echo3/
2. Navigate to the newly-cloned location in the Terminal (e.g. ~/dev/echo3).
3. Run ./build.sh
   1. Alternatively, after cloning, you can open the cloned folder as a workspace in Visual Studio Code (a free and open source code editor installable via sudo snap install --classic code).
   2. Note that all options require build tools for C++, such as cmake, make and the g++ compiler. If it doesn't work, see Installing g++.

On Windows

See Development on Windows.

Building Echo

The installer script will attempt to build Echo for all targets that were selected (including Debug and Release for Linux). If you want, or need to, to build manually you can do any one of the following:

• Navigate to the cloned Echo directory and run ./BuildEcho.sh. The default platform is linux. You can specify the platform you want using PLATFORMS=platformname ./BuildEcho.sh where platformname is the lowercase name of the platform. At the time of this writing the following were available: linux, android, wii, windowscross.
• Navigate to the echo3 project folder and issue the command make CONF=Release to build a Linux Release build, CONF can be set to the platform configuration you want to target. For example make CONF=Wii builds the Wii configuration. You can see possible configurations by opening echo3/nbproject. Each configuration has a makefile.
• Open the echo3 project in NetBeans and build using the IDE. **Note that the project will only open if the C++ NetBeans module is installed else Netbeans will error with <unrecognized project; missing plug-in?>.

Verifying things worked

You should receive output if there were errors to the above processes. The installer will output the build result to a buildlogs folder that you can inspect to find errors. Please Please report errors that you come across since we do want the process to be error free when possible.

To verify that everything built and that you can run an Echo project you can run the tests.

make test

Will run through the unit tests for the library. A lot of these tests are graphical and are set to timeout after 30 seconds or so but you can close windows early. If 30 seconds elapses and the window doesn't close, chances are we forgot to add the timeout. Please report it so we can fix it.

Once you're satisfied and have had fun playing with the tests you can move to the Getting started page for information on building an application.