Skip to content

Commit 344b258

Browse files
committed
Added dev notes.
1 parent 9ed26d5 commit 344b258

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
##### Table of Contents
1313

1414
* [About](#about-)
15-
* [Build](#build-)
16-
* [Start the Project REPL](#start-the-repl-)
15+
* [Dev Process](#dev-process-)
1716
* [Tests](#tests-)
1817
* [Usage](#usage-)
1918
* [License](#license-)
@@ -28,17 +27,26 @@ The xrepl project has as its primary mission:
2827
2928
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.
3029

31-
## Build [↟](#table-of-contents)
30+
## Dev Process [↟](#table-of-contents)
3231

33-
```shell
34-
$ rebar3 lfe compile
35-
```
32+
**HIC SVNT DRACONES**
3633

37-
## Start the Project REPL [↟](#table-of-contents)
34+
This project is a work in progress -- _very_ early stages!
3835

39-
```shell
40-
$ rebar3 lfe repl
41-
```
36+
If that hasn'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:
37+
38+
1. `git clone [email protected]:lfe/xrepl.git`
39+
1. `cd xrepl`
40+
1. `mkdir _checkouts && cd _checkouts`
41+
1. `git clone [email protected]:lfe/rebar3.git`
42+
1. `cd rebar3 && git checkout release/0.5.x`
43+
1. `cd ../../../`
44+
45+
At this point, you should be:
46+
47+
1. Back in the xrepl project directory
48+
1. Have a local copy of the latest rebar3 branch
49+
1. Be using said branch when you execute `rebar3 lfe ...` commands
4250

4351
## Tests [↟](#table-of-contents)
4452

0 commit comments

Comments
 (0)