From 488004871a2a6c581effee302c4985b5e9a2a596 Mon Sep 17 00:00:00 2001 From: John Stevenson Date: Wed, 10 Oct 2018 23:02:23 +0100 Subject: [PATCH] Starting rework of development environment section Starting with new install guide for Atom Proton with ProtoREPL. Using collapsible sections for operating system specific instructions. --- SUMMARY.md | 33 ++++---- .../install-guides/index.md | 3 + .../install-guides/proton.md | 79 +++++++++++++++++++ 3 files changed, 96 insertions(+), 19 deletions(-) create mode 100644 development-environment/install-guides/index.md create mode 100644 development-environment/install-guides/proton.md diff --git a/SUMMARY.md b/SUMMARY.md index b008cb7..00b586c 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -101,26 +101,21 @@ * [Development Enviromment](development-environment/index.md) * [Java](development-environment/java.md) * [Leiningen](development-environment/leiningen.md) - * [Editor Guides](development-environment/editor-guides/index.md) - * [LightTable](development-environment/editor-guides/lighttable.md) - * [Linux](development-environment/editor-guides/lighttable-linux.md) - * [MacOSX](development-environment/editor-guides/lighttable-macosx.md) - * [Windows](development-environment/editor-guides/lighttable-windows.md) + * [Editor install guides](development-environment/install-guides/index.md) + * [Atom.io and ProtoREPL](development-environment/install-guides/protorepl.md) + * [Atom.io and Proton](development-environment/install-guides/proton.md) + * [VS Code and Calva](development-environment/install-guides/vscode-calva.md) + * [Emacs and Spacemacs](development-environment/install-guides/emacs-spacemacs.md) + * [IntelliJ and Cursive](development-environment/install-guides/intellij-cursive.md) + * [LightTable](development-environment/install-guides/lighttable.md) * [LightTable InstaREPL](introducing-clojure/lighttable-instarepl.md) - * [Using LightTable Instarepl](introducing-clojure/trying-the-instarepl.md) - * [Evaluate ClojureBridge Project](introducing-clojure/evaluate-turtle-project.md) - * [Spacemacs](development-environment/editor-guides/spacemacs.md) - * [Linux](development-environment/editor-guides/spacemacs-linux.md) - * [MacOSX](development-environment/editor-guides/spacemacs-macosx.md) - * [Windows](development-environment/editor-guides/spacemacs-windows.md) - * [Protorepl](development-environment/editor-guides/protorepl.md) - * [Linux](development-environment/editor-guides/protorepl-linux.md) - * [MacOSX](development-environment/editor-guides/protorepl-macosx.md) - * [Windows](development-environment/editor-guides/protorepl-windows.md) - * [Microsoft Code](development-environment/editor-guides/microsoft-code.md) - * [Linux](development-environment/editor-guides/microsoft-code-linux.md) - * [MacOSX](development-environment/editor-guides/microsoft-code-macosx.md) - * [Windows](development-environment/editor-guides/microsoft-code-windows.md) + * [Test your Editor](introducing-clojure/evaluate-turtle-project.md) + * [Editor User Guides](development-environment/editor-guides/index.md) + * [Atom.io and Protorepl](development-environment/editor-guides/protorepl.md) + * [Emacs and Spacemacs](development-environment/editor-guides/spacemacs.md) + * [VS Code and Calva](development-environment/editor-guides/vscode-calva.md) + * [LightTable](development-environment/editor-guides/lighttable.md) + * [Using LightTable Instarepl](introducing-clojure/trying-the-instarepl.md) * [Contribute](contribute.md) * [Fancy Keyboard Keys](fancy-keyboard-keys.md) * [Klipse](klipse/index.md) diff --git a/development-environment/install-guides/index.md b/development-environment/install-guides/index.md new file mode 100644 index 0000000..3341599 --- /dev/null +++ b/development-environment/install-guides/index.md @@ -0,0 +1,3 @@ +# Editor Install Guides + +To continue working on Clojure after the event, we recommend installing one of the following editors: diff --git a/development-environment/install-guides/proton.md b/development-environment/install-guides/proton.md new file mode 100644 index 0000000..bc7dfd2 --- /dev/null +++ b/development-environment/install-guides/proton.md @@ -0,0 +1,79 @@ +# Atom Proton + +> #### TODO:: work in progress, corrections and pull requests welcome + +[Proton-mode](https://github.com/dvcrn/proton) gives a Spacemacs-like experience to the Atom editor + +Proton-mode provides a mnemonic menu and set of keybindings that offer an effective alternative to the interesting keybindings with Atom and ProtoREPL. It also provides modal editing features, simplifying keybindings. + +[![Proton-mode](/images/proton-mode.gif)](/images/proton-mode.gif) + +## Install Atom.io + +Follow the instructions for your operating system + + + +Download the latest `.deb` file from Atom.io + +Once downloaded, double-click the `.deb` file to install. + +To run atom, press the `Super` key and type `atom`, or open a terminal and type the command `atom`. + + + +Download the latest `.rpm` file from Atom.io + +Once downloaded, double-click the `.rpm` file to install. + +To run atom, press the `Super` key and type `atom`, or open a terminal and type the command `atom`. + + + +Pull request welcome + + + +Pull request welcome + + + +## Install Proton + +Required packages + +* [ink](https://atom.io/packages/ink) - Proto REPL dependency used for inline display and the REPL output. +* [proto-repl](https://github.com/jasongilman/proto-repl) - Clojure REPL, autocompletion, etc. +* [Proton-mode](https://github.com/dvcrn/proton) - Spacemacs style menu and keybindings to make Atom easier to use (included Vim / Emacs keybinding support) + +Recommended packages + +* [lisp-paredit](https://atom.io/packages/lisp-paredit) - to manage your `()` +* [proto-repl-charts](https://github.com/jasongilman/proto-repl-charts) - graphs and charts +* tool-bar - displays a REPL tool bar +* highlight-selected - highlights selected keywords throughout an editor + + +## Download the sample project + +We have created an example Clojure project called "Welcome To ClojureBridge" to test your development tools. + + + +[Download the "Welcome To ClojureBridge" zip file](https://github.com/ClojureBridgeLondon/welcometoclojurebridge/archive/master.zip) and extract all the files. + + + +If you are comfortable using the git version control tool and the command line, then you can clone the project using git + +```bash +git clone https://github.com/ClojureBridge/welcometoclojurebridge +``` + + + +## Test your editor with a clojure project + +`SPC f f` and navigate to the `core.clj` file in the `welcometoclojurebridge` project. + +`, s i` to start a Clojure REPL and display the REPL in a new window.