diff --git a/README.md b/README.md index 5ed776e..771e077 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,17 @@ Some documentation is available at [https://lspector.github.io/propeller/](https ## About this fork -This is mainly for personal use to develop inside of Nix environment. Check out the original on package on (github)[https://github.com/lspector/propeller] +This is mainly for personal use to develop inside of Nix environment. Check out the original on package on [github](https://github.com/lspector/propeller). + +### How to jack into the project + +Once you've ran `nix develop` and vscodium has appeared, click the REPL +button in the bottom left of the screen. Click +`Start your project with a REPL and connect (a.k.a Jack-in)`, select +`Leiningen`, and don't select a profile, instead click `OK`. A window should appear to the right with Calva's REPL. + +Head over to `src/propeller/session.cljc` as described below and click +`ctrl + alt + c` then `Enter` to source the session file. ## Usage