about summary refs log tree commit diff
path: root/users/wpcarro/boilerplate/clojure/README.md
blob: 53590850bcd93688482d96e8c03f554db0f5734c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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
```