search

vvvvalvalval / scope-capture

Project your Clojure(Script) REPL into the same context as your code when it ran
MIT License
573 stars 14 forks source link

Add Installation instructions and a copy-pastable dependency info #16

Closed DjebbZ closed 6 years ago

DjebbZ commented 6 years ago

Instructions shamelessly copied from https://github.com/jsofra/data-scope

DjebbZ commented 6 years ago

Finally started to use it. Lovin' it already :cupid:

My thanks in a PR :wink:

vvvvalvalval commented 6 years ago

@DjebbZ Thanks, interesting, I did not know this trick. However, have you tested this approach for (many flavors of) ClojureScript? I need this to work for a wide variety of REPLs, and preferrably not presume that the REPL was setup via Boot or Leiningen.

If this approach is not portable, I'd rather document it in something like a 'Tips and Tricks' section of the documentation (which would be referenced in the README).

DjebbZ commented 6 years ago

Well, I recommend against hiding basing instructions far from the eyes. A good README should include the basic instructions to start right away. Look at the ClojureScript repo, Om, Reagent, Leiningen, Ring, or even Golang or Rails. They all display clear and proeminent basic installation instructions.

Now, I haven't tested at all the ClojureScript part, neither a bare Clojure REPL. I understand it can be trickier and that my contrib doesn't explain these cases. But one can always add them later.

Last note : unless it's tricky, I wouldn't hide this information from the README.

Keep up the good work !

(Note to self : contribute a Table of Content)

vvvvalvalval commented 6 years ago

Fair enough, merging. I'm also working on some documentation to help people get started, so expect some changes soon :)

Thanks for helping out!