Skip to content

Commit ec112f6

Browse files
committed
Add instructions [WIP]
1 parent 852b178 commit ec112f6

12 files changed

+54
-8
lines changed

Diff for: .gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@ pom.xml.asc
1212
.lein-failures
1313
.nrepl-port
1414
.cpcache/
15+
16+
.calva/**/*.calva-repl
17+
.lsp/sqlite*.db

Diff for: .gitpod.Dockerfile

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
FROM gitpod/workspace-full
22

33
RUN brew install clojure/tools/clojure
4-
RUN brew install leiningen
5-

Diff for: .gitpod.yml

+11-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,14 @@ image:
33

44
vscode:
55
extensions:
6-
- betterthantomorrow.calva
6+
- betterthantomorrow.calva
7+
8+
tasks:
9+
- name: Prepare deps
10+
init: clojure -Sdeps '{:deps {nrepl/nrepl {:mvn/version,"0.8.3"},cider/cider-nrepl {:mvn/version,"0.26.0"}}}' -P
11+
- name: INSTRUCTIONS
12+
command: code doc/INSTRUCTIONS.md
13+
14+
github:
15+
prebuilds:
16+
main: true

Diff for: .vscode/settings.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"workbench.editorAssociations": {
3+
"INSTRUCTIONS.md": "vscode.markdown.preview.editor"
4+
}
5+
}

Diff for: README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
A zero-install, interactve, guide to get you started with [Clojure](https://clojure.org/) using [Calva](https://calva.io/)'s **Getting Started REPL**.
44

5-
<div style="margin: 30px 0 30px 0;; display: flex; justify-content: space-around;">
6-
<img src="doc/clj.png" height=300>
7-
<img src="doc/calva-symbol.png" height=300>
5+
![Clojure and Calva](doc/clojure-and-calva.png)
86

9-
</div>
7+
## OK, but how?
108

11-
Read about how to use it here: [calva.io/get-started-with-clojure](https://calva.io/get-started-with-clojure/).
9+
Read about what this is here: [calva.io/get-started-with-clojure](https://calva.io/get-started-with-clojure/).
10+
11+
When you've read that, open [doc/INSTRUCTIONS.md](doc/INSTRUCTIONS.md)

Diff for: deps.edn

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

Diff for: doc/INSTRUCTIONS.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# How to use The Getting Started REPL
2+
3+
The Getting Started REPL connects Calva to three files, which will serve as your interactive guides:
4+
5+
- `hello_repl.clj` – The basics of how to evaluate code in Calva (i.e. using the REPL)
6+
- `hello_paredit.clj` - A super brief intro to Calva structural editing ([Paredit](https://calva.io/paredit))
7+
- `welcome_to_clojure.clj` - The very basics of the Clojure language
8+
9+
The files contain a mix of guiding text and snippets of code. You will use the REPL to evaluate the code and sometimes you will be asked to write some code and evaluate that.
10+
11+
If you haven't already, you should start with reading [calva.io/get-started-with-clojure](https://calva.io/get-started-with-clojure/).
12+
13+
## Let's go!
14+
15+
First you need to fire up the Getting Started REPL:
16+
17+
1. Click the **REPL** button in the status bar
18+
19+
![VS Code Statusbar with Clojure REPL button](doc/status-bar-repl-button.png)
20+
21+
<details><summary>Don't see the REPL button?</summary>
22+
23+
This could be because some firewall or adblocker prevents the downloading of the Calva extension. See [issue #9](https://github.com/PEZ/rich4clojure/issues/9) for more clues on this.
24+
25+
</details>
26+
1. Select **Fire up the ”Getting Started” REPL** from the quick pick menu.
27+
![The Calva REPL Menu](doc/repl-menu.png)
28+
29+

Diff for: doc/calva-symbol.png

-48.9 KB
Binary file not shown.

Diff for: doc/clj.png

-30 KB
Binary file not shown.

Diff for: doc/clojure-and-calva.png

19.8 KB
Loading

Diff for: doc/repl-menu.png

53.4 KB
Loading

Diff for: doc/status-bar-repl-button.png

36.6 KB
Loading

0 commit comments

Comments
 (0)