Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 3.45 KB

README.md

File metadata and controls

93 lines (63 loc) · 3.45 KB
Raw

xrepl

Build Status LFE Versions Erlang Versions Tags

Project Logo

An experimental, general purpose LFE REPL

Table of Contents

About ↟

This project has a long history of not coming into being, despite there being a need for it in the LFE community from fairly early in the language's history. The initial impetus and all subsquent community feature requests have been 100% inspired by what the larger Clojure community has in the nREPL project.

The xrepl project has as its primary mission:

To explore strange new LFE REPL use cases, to seek out new REPL features and new interactive development possibilities, to boldly go where LFE-proper hasn't gone. Yet.

Anything good that comes out of this project that may be even remotely useful to LFE itself will result in a ticket and/or a PR against the LFE repository for Robert's reading pleasure and discretionary approval.

Dev Process ↟

HIC SVNT DRACONES

This project is a work in progress -- very early stages!

There's a lot of work to be done, here -- the bits that have been written down are organised by milestone, here:

Specific tickets can be view by clicking on the milestone in question in that link. Keep an eye out for "epic" tickets, as those will provide the most context for the work being done in any given milestone.

If the above notes haven't scared you off and you would like to play (or even contribute), you can run the latest xrepl code using rebar3_lfe by doing the following:

  1. git clone [email protected]:lfe/xrepl.git
  2. cd xrepl
  3. mkdir _checkouts && cd _checkouts
  4. git clone [email protected]:lfe/rebar3.git
  5. cd rebar3 && git checkout release/0.5.x
  6. cd ../../../

At this point, you should be:

  1. Back in the xrepl project directory
  2. Have a local copy of the latest rebar3 branch
  3. Be using said branch when you execute rebar3 lfe ... commands

Tests ↟

$ rebar3 as test lfe ltest

Usage ↟

Assuming you've following the above steps, start up xrepl with the following:

$ rebar3 lfe xrepl

License ↟

Apache License, Version 2.0

Copyright © 2024, The LFE Community <http://lfe.io>.