diff --git a/CHANGELOG.md b/CHANGELOG.md index d0c9f5f10..df6d9ec1f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ Changes to Calva. ## [Unreleased] - Fix [Connect ”not in project” glitches](https://github.com/BetterThanTomorrow/calva/issues/814) +- [Add two ”Start Standalone REPL” commands](https://github.com/BetterThanTomorrow/calva/issues/1003) ## [2.0.171] - 2021-02-10 - Update clojure-lsp to version 2021.02.09-18.28.06 (Fix: [Auto completion does not work in clojure-lsp only mode (no repl connection)](https://github.com/BetterThanTomorrow/calva/issues/996#issuecomment-776148282)) diff --git a/docs/site/commands-top10.md b/docs/site/commands-top10.md index e88cd5b95..168d0bf9f 100644 --- a/docs/site/commands-top10.md +++ b/docs/site/commands-top10.md @@ -2,7 +2,7 @@ There are not all that many Calva commands. You can learn them all if you like, but here are the most important ones to know about for effective Clojure/ClojureScript coding: -* **Grow/expand selection**: `ctrl+w` +* **Grow/expand selection**: (Check the VS Code Command Palette for the keyboard shortcut) * **Load current file**: `alt+ctrl+c enter`, evaluates the namespace code in the active editor tab. This also loads any required namespaces, and generally gives Calva what it needs to work. * **Evaluate current form**: `ctrl+enter` finds the form from the cursor position, evaluates it and displays the result inline. Hit `esc` to dismiss the results display. * **Evaluate current top-level form**: `alt+enter`: inline evaluate the current top-level form. This also works inside `(comment)` forms. Use it to (re)define vars and then inside comment forms you can verify that they do what you want them to do. diff --git a/docs/site/getting-started.md b/docs/site/getting-started.md new file mode 100644 index 000000000..486960b88 --- /dev/null +++ b/docs/site/getting-started.md @@ -0,0 +1,38 @@ +# Getting Started + +Depending on wether you want to just start a Clojure REPL or you have a project you want to work with, getting started looks similar but a bit different. Both start with: + +0. You have VS Code started +1. You install Calva + +## Start a Standalone REPL + +If you are new to Calva, a good place to start is using the command **Start a standalone ”Hello World” REPL**. + +![Command Palette Start Standaloe REPL](images/howto/start-hello-repl.png "Start a Standalone REPL") + +It will open up a file named `hallo-repl.clj` in a temporary directory, and start and connect a REPL. The file contains some sample code and a few tips on how to evaluate code in a Calva editor. + +![Hello REPL](images/howto/hello-repl.png "hello-repl.clj") + + +The only prerequisite here is that you have Java installed. _No pre-installed clojure tools required._ (You will want to install these tools later, of course.) + +!!! Note + When you are more familiar with Calva, and want a standalone REPL, there is a separate command: **Start a standalone REPL (not in project)**. It will open up a `user.clj` in a temporary directory, containing only an `(ns user)` form, and start and connect the REPL. + +## You have a Project? + +If you are new to Calva, please consider the above option first. Then when it it will be time to get [Calva connected to the REPL of your project](connect.md). + +## Clojure Resources + +If you are new to Clojure or ClojureScript altogether, please check out the guide material on the respective official sites: + +- [Getting Started with Clojure](https://clojure.org/guides/getting_started) +- [ClojureScript Quick Start](https://clojurescript.org/guides/quick-start) + +There are also many great books on Clojure. [Clojure for the Brave and True](https://www.braveclojure.com/clojure-for-the-brave-and-true/) can be read for free online. It is a great resource for beginners. + + +Happy coding! ♥️ diff --git a/docs/site/images/howto/hello-repl.png b/docs/site/images/howto/hello-repl.png new file mode 100644 index 000000000..7326ba1c0 Binary files /dev/null and b/docs/site/images/howto/hello-repl.png differ diff --git a/docs/site/images/howto/start-hello-repl.png b/docs/site/images/howto/start-hello-repl.png new file mode 100644 index 000000000..198d30e9c Binary files /dev/null and b/docs/site/images/howto/start-hello-repl.png differ diff --git a/docs/site/index.md b/docs/site/index.md index 2fd620e9f..fc66a3a66 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -6,14 +6,7 @@ ## Getting Started -First thing you need to do is to get [Calva connected to the REPL of your project](connect.md). Then we suggest you check out [Something to Try First](try-first.md). - -If you are new to Clojure or ClojureScript altogether, please check out the guide material on the respective official sites: - -- [Getting Started with Clojure](https://clojure.org/guides/getting_started) -- [ClojureScript Quick Start](https://clojurescript.org/guides/quick-start) - -There are also many great books on Clojure. [Clojure for the Brave and True](https://www.braveclojure.com/clojure-for-the-brave-and-true/) can be read for free online, and is a great resource for beginners. +[Let's start a REPL!](getting-started.md). 🚀 ## How to Contribute to Calva? diff --git a/mkdocs.yml b/mkdocs.yml index d033149ce..27de5f22f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,7 +21,8 @@ markdown_extensions: - codehilite nav: - index.md - - Getting Started: + - Start Here: + - getting-started.md - connect.md - try-first.md - finding-commands.md