Skip to content
This repository was archived by the owner on Oct 21, 2022. It is now read-only.

Commit 2aeab5c

Browse files
committed
Clean up plugin description for committers
1 parent 815ce9b commit 2aeab5c

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,17 @@ Distributed under the MIT License, see license.md for the full text.
9797

9898
## For Committers
9999

100-
* Project layout
101-
* runner/: Contains uberjar to inject our nREPL middleware into a project and then start a repl
102-
* lein-light-nrepl/: Contains nREPL middleware that needs to be deployed to Clojars when changed
103-
* src/ and everything else: Normal LightTable plugin
104-
* When releasing a new plugin version and lein-light-nrepl has changed:
105-
* Bump lein-light-nrepl and lein-light in runner/.
106-
* Update the uberjar with `lein uberjar` in `runner` to produce `runner/target/lein-light-standalone.jar`.
107-
* Release the new version of lein-light-nrepl to [clojars](https://clojars.org/lein-light-nrepl)
108-
* No process for upgrading `clojure-mode.js` until [this issue](https://github.com/LightTable/Clojure/issues/26) is addressed.
100+
Plugin consists of the following components:
101+
102+
* `lein-light-nrepl/`: nREPL middleware that is released as a clojars library
103+
* `runner/`: Uberjar that kicks off a connection to a Clojure(Script) project
104+
* `build.sh`: Script that rebuilds uberjar with any changes made to lein-light-nrepl and runner. Any Clojure connections must be restarted for this change to take effect.
105+
* `codemirror/clojure-mode.js`: Forked version of CodeMirror's clojure mode.
106+
* There is no process for upgrading `clojure-mode.js` until [this issue](https://github.com/LightTable/Clojure/issues/26) is addressed.
107+
* `src/`: Normal LightTable plugin
108+
109+
When releasing a new plugin version and lein-light-nrepl has changed:
110+
111+
* Bump lein-light-nrepl and lein-light in runner/.
112+
* Update the uberjar with `lein uberjar` in `runner` to produce `runner/target/lein-light-standalone.jar`.
113+
* Release the new version of lein-light-nrepl to [clojars](https://clojars.org/lein-light-nrepl)

0 commit comments

Comments
 (0)