From 30bfce980b459e7ce6e6538bfe3af644fd1eac92 Mon Sep 17 00:00:00 2001 From: Aditya Athalye Date: Mon, 4 Mar 2024 14:14:13 +0530 Subject: [PATCH 1/6] Fix typos. Replace redundant reference to VSCode, now that we have switched to it over IntelliJ. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a59f950..7fa3191 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ Just do the following one by one, and you should be fine. ## VSCode + Calva -We support VSCode + Calva IDE in the classroom for this workshop. We suggest you use this setup, unless of course, you have already configured your favourite editor for Clojure development. We've listed alternate starter kits below (VSCode, Vim, Emacs, Atom), _but_ please avoid [bikeshedding](http://catb.org/jargon/html/B/bikeshedding.html) editors. Just complete the workshop first! +We support VSCode + Calva IDE in the classroom for this workshop. We suggest you use this setup, unless of course, you have already configured your favourite editor for Clojure development. We've listed alternate starter kits below (IntelliJ, Vim, Emacs, Atom), _but_ please avoid [bikeshedding](http://catb.org/jargon/html/B/bikeshedding.html) editors. Just complete the workshop first! - Download and Install [VSCode](https://code.visualstudio.com/) - Open VSCode and complete the initialization process. @@ -99,7 +99,7 @@ Once installed: - Clone the repository on your machine - In VSCode Use File > Open Folder... and open the cloned folder - Notice that Calva activates -- Open the [Command Pallete](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) in VSCode using `⇧⌘P` on Mac or `Ctrl+Shift+P` on other systems +- Open the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) in VSCode using `⇧⌘P` on Mac or `Ctrl+Shift+P` on other systems - Type "Calva: Start Project REPL" and choose "Calva: Start a Project REPL and Connect (aka Jack-In)" from the list - Select `deps.edn` when prompted for Project type. We are using [tools.deps](https://clojure.org/guides/deps_and_cli) for managing the project. You don't need to worry about it's details for this workshop - VSCode will create a new pane called 'output.calva-repl' and you will see `clj꞉user꞉>` prompt in that screen From 189d847c4e297c8c8d5381801997e223b87e3110 Mon Sep 17 00:00:00 2001 From: Aditya Athalye Date: Mon, 4 Mar 2024 14:15:47 +0530 Subject: [PATCH 2/6] Deduplicate Java install instruction. Move it above IDE install instructions. --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7fa3191..2c11bf1 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,18 @@ Take what is useful, discard the rest. Just do the following one by one, and you should be fine. +## Java + +You need Java installed. + +- Run `java -version` in your terminal. +- If Java is not installed, please [download and install Java from here](https://adoptopenjdk.net/). Any version should do. +- Once you are done, `java -version` should show you a Java version. + +Notes: + +- We have not tested this project with Java 7. + ## VSCode + Calva We support VSCode + Calva IDE in the classroom for this workshop. We suggest you use this setup, unless of course, you have already configured your favourite editor for Clojure development. We've listed alternate starter kits below (IntelliJ, Vim, Emacs, Atom), _but_ please avoid [bikeshedding](http://catb.org/jargon/html/B/bikeshedding.html) editors. Just complete the workshop first! @@ -89,10 +101,6 @@ We support VSCode + Calva IDE in the classroom for this workshop. We suggest you - Open VSCode and complete the initialization process. - Open the "Extensions" Tab and search for "Calva", Install the "Calva: Clojure & ClojureScript Interactive Programming" extension - Alternatively you can visit the [Calva page](https://marketplace.visualstudio.com/items?itemName=betterthantomorrow.calva) to install it -- You need Java Installed - - Run `java -version` in your terminal. - - If Java is not installed, please [download and install Java from here](https://adoptopenjdk.net/). Any version should do. - - Once you are done, `java -version` should show you a Java version. Once installed: @@ -107,16 +115,6 @@ Once installed: - Keep the [Paredit guide](https://calva.io/paredit/) handy, editing code will require some understanding of paredit. -### Java - -- Run `java -version` in your terminal. -- If Java is not installed, please [download and install Java from here](https://adoptopenjdk.net/). Any version should do. -- Once you are done, `java -version` should show you a Java version. - -Notes: - -- We have not tested this project with Java 7. - ## Your favourite editor: You may find instructions for your favourite editor at one of these pages. But there are only so many choices. Ultimately, you must pick your poison and run with it: From 50854a67ce3e5dd8f00b14efce7880f13f2e0157 Mon Sep 17 00:00:00 2001 From: Aditya Athalye Date: Mon, 4 Mar 2024 14:17:53 +0530 Subject: [PATCH 3/6] Consistently period-terminate bullet points, as we are using sentences over phrases. Either style is fine, as long as it is consistent. --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2c11bf1..686e5f2 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ A small but vibrant [global community](https://clojure.org/community/user_groups - Support a 1-day guided workshop for programmers new to Clojure (not absolute programming beginners). - Also function as at-home learning material for said programmers. -- The `master` branch is heavily commented, for at-home use +- The `master` branch is heavily commented, for at-home use. - A `solutions` branch will be available, as a companion to `master`. But don't peek at it in advance! - You may see a `workshop-code` branch. Ignore it. It is meant only for @@ -97,20 +97,21 @@ Notes: We support VSCode + Calva IDE in the classroom for this workshop. We suggest you use this setup, unless of course, you have already configured your favourite editor for Clojure development. We've listed alternate starter kits below (IntelliJ, Vim, Emacs, Atom), _but_ please avoid [bikeshedding](http://catb.org/jargon/html/B/bikeshedding.html) editors. Just complete the workshop first! -- Download and Install [VSCode](https://code.visualstudio.com/) +- Download and Install [VSCode](https://code.visualstudio.com/). - Open VSCode and complete the initialization process. -- Open the "Extensions" Tab and search for "Calva", Install the "Calva: Clojure & ClojureScript Interactive Programming" extension - - Alternatively you can visit the [Calva page](https://marketplace.visualstudio.com/items?itemName=betterthantomorrow.calva) to install it +- Open the "Extensions" Tab and search for "Calva", Install the "Calva: + Clojure & ClojureScript Interactive Programming" extension. +- Alternatively you can visit the [Calva page](https://marketplace.visualstudio.com/items?itemName=betterthantomorrow.calva) to install it. Once installed: -- Clone the repository on your machine -- In VSCode Use File > Open Folder... and open the cloned folder -- Notice that Calva activates -- Open the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) in VSCode using `⇧⌘P` on Mac or `Ctrl+Shift+P` on other systems -- Type "Calva: Start Project REPL" and choose "Calva: Start a Project REPL and Connect (aka Jack-In)" from the list - - Select `deps.edn` when prompted for Project type. We are using [tools.deps](https://clojure.org/guides/deps_and_cli) for managing the project. You don't need to worry about it's details for this workshop - - VSCode will create a new pane called 'output.calva-repl' and you will see `clj꞉user꞉>` prompt in that screen +- Clone the repository on your machine. +- In VSCode Use File > Open Folder... and open the cloned folder. +- Notice that Calva activates. +- Open the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) in VSCode using `⇧⌘P` on Mac or `Ctrl+Shift+P` on other systems. +- Type "Calva: Start Project REPL" and choose "Calva: Start a Project REPL and Connect (aka Jack-In)" from the list. + - Select `deps.edn` when prompted for Project type. We are using [tools.deps](https://clojure.org/guides/deps_and_cli) for managing the project. You don't need to worry about it's details for this workshop. + - VSCode will create a new pane called 'output.calva-repl' and you will see `clj꞉user꞉>` prompt in that screen. - You have a working REPL now! - Keep the [Paredit guide](https://calva.io/paredit/) handy, editing code will require some understanding of paredit. From a76d055eaa6dee56e974677103089343b9796477 Mon Sep 17 00:00:00 2001 From: Aditya Athalye Date: Mon, 4 Mar 2024 14:26:24 +0530 Subject: [PATCH 4/6] Tighten Java install instructions --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 686e5f2..c12566b 100644 --- a/README.md +++ b/README.md @@ -86,13 +86,11 @@ Just do the following one by one, and you should be fine. You need Java installed. - Run `java -version` in your terminal. -- If Java is not installed, please [download and install Java from here](https://adoptopenjdk.net/). Any version should do. +- If Java is not installed, please [download and install Java from here](https://adoptopenjdk.net/). +- Any version should do, but prefer Java 8 or higher. We have not tested + this project with Java 7. - Once you are done, `java -version` should show you a Java version. -Notes: - -- We have not tested this project with Java 7. - ## VSCode + Calva We support VSCode + Calva IDE in the classroom for this workshop. We suggest you use this setup, unless of course, you have already configured your favourite editor for Clojure development. We've listed alternate starter kits below (IntelliJ, Vim, Emacs, Atom), _but_ please avoid [bikeshedding](http://catb.org/jargon/html/B/bikeshedding.html) editors. Just complete the workshop first! From 37e5c09ef175e5efe674c83f64ec5276332311fa Mon Sep 17 00:00:00 2001 From: Aditya Athalye Date: Mon, 4 Mar 2024 14:37:40 +0530 Subject: [PATCH 5/6] Fix copyright notice, up to 2024 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c12566b..be8f605 100644 --- a/README.md +++ b/README.md @@ -148,6 +148,6 @@ Live long, and prosper. ## Copyright and License -Copyright © 2017-2018 [IN/Clojure](http://inclojure.org/). +Copyright © 2017-2024 [IN/Clojure](http://inclojure.org/). Distributed under the [MIT license](https://github.com/inclojure-org/clojure-by-example/blob/master/LICENSE). From 0375b255d6f2d3dc6bfb98036cb0b932b63b1ebb Mon Sep 17 00:00:00 2001 From: Aditya Athalye Date: Mon, 4 Mar 2024 14:49:52 +0530 Subject: [PATCH 6/6] Fix bullet point line space rendering. The blank line caused rendered text to display each bullet point as a paragraph, instead of a list item. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index be8f605..730b1dc 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,6 @@ Once installed: - Select `deps.edn` when prompted for Project type. We are using [tools.deps](https://clojure.org/guides/deps_and_cli) for managing the project. You don't need to worry about it's details for this workshop. - VSCode will create a new pane called 'output.calva-repl' and you will see `clj꞉user꞉>` prompt in that screen. - You have a working REPL now! - - Keep the [Paredit guide](https://calva.io/paredit/) handy, editing code will require some understanding of paredit. ## Your favourite editor: