Skip to content

Commit

Permalink
Add escript/dap instructions to README
Browse files Browse the repository at this point in the history
Summary: Add instructions on how to produce an `edb` escript and how to start a DAP adapter.

Reviewed By: jcpetruzza

Differential Revision: D68012720

fbshipit-source-id: 519abfc8767c0fb63fe3edd548ba3c365ddf2191
  • Loading branch information
robertoaloi authored and facebook-github-bot committed Jan 10, 2025
1 parent 965219f commit 42d0538
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,25 @@ Run Tests

$ rebar3 ct

Produce an Escript
------------------

You can produce an [escript](https://www.erlang.org/doc/apps/stdlib/escript.html) executable for the `edb` project.
This is convenient to use the debugger from an IDE via the [DAP](https://microsoft.github.io/debug-adapter-protocol/) protocol.

$ rebar3 escriptize

The produced `edb` escript will be available in:

_build/default/bin/edb

Start the DAP adapter for `edb`
-------------------------------

To start the debugger CLI

$ _build/default/bin/edb dap

License
-------

Expand Down

0 comments on commit 42d0538

Please sign in to comment.