diff options
Diffstat (limited to 'users/wpcarro/boilerplate/clojure/README.md')
-rw-r--r-- | users/wpcarro/boilerplate/clojure/README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/users/wpcarro/boilerplate/clojure/README.md b/users/wpcarro/boilerplate/clojure/README.md new file mode 100644 index 000000000000..53590850bcd9 --- /dev/null +++ b/users/wpcarro/boilerplate/clojure/README.md @@ -0,0 +1,33 @@ +# Clojure Boilerplate + +This boilerplate uses `lein` to manage the project. + +## Files to change + +To use this boilerplate, run the following in a shell: + +```shell +$ cp -r . path/to/new-project +``` + +After running the above command, change the following files to remove the +placeholder values: + +- `README.md`: Change the title; change the description; drop "Files to change"; + keep "Getting started" +- `project.clj`: Change title +- `src/main.clj`: Change `:doc`; drop `main/foo` + +## Getting started + +From a shell, run: + +```shell +$ lein repl +``` + +From Emacs, navigate to a source code buffer and run: + +``` +M-x cider-jack-in +``` |