Skip to content

Getting Started

Juan José González Abril edited this page Nov 9, 2020 · 1 revision

Download

To download CauDEr from GitHub run the following command in a terminal:

git clone https://github.com/mistupv/cauder-v2.git

Or the following one in the GitHub CLI:

gh repo clone mistupv/cauder-v2

Requirements

  • Erlang/OTP (≥ 23.1)
  • Make

Build

To build CauDEr from the previously downloaded code, first navigate to the folder where it was downloaded:

cd cauder-v2

And then run the following command to compile the source code:

make

This will also generate a new file named cauder.sh

Run

CauDEr is divided in two components (servers) the debugger itself and a GUI, which allows to start the debugger with or without the included GUI.

Erlang shell

Debugger only

To start the debugger server run de following command in the Erlang shell:

Eshell V11.1  (abort with ^G)
1> cauder:start(). % Starting the debugger
{ok,<0.80.0>}

Debugger and GUI

To start the debugger and the GUI servers run de following commands in the Erlang shell:

Eshell V11.1  (abort with ^G)
1> cauder:start(). % Starting the debugger
{ok,<0.80.0>}
2> cauder_wx:start(). % Starting the GUI
{ok,<0.82.0>,{wx_ref,35,wxFrame,<0.82.0>}}

Alternatively, you can simply start the GUI server, which will look for the debugger and will start it if it is not running yet:

Eshell V11.1  (abort with ^G)
1> cauder_wx:start(). % Starting the GUI and the debugger
{ok,<0.81.0>,{wx_ref,35,wxFrame,<0.81.0>}}

Shell script

An easier way to start CauDEr is to run the script generated during compilation:

./cauder.sh

Usage

CauDEr can be used either from the Erlang shell, from its GUI or from both at the same time, check the Usage page to learn how.

Clone this wiki locally