Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 226 lines (186 sloc) 9.471 kb
624832e Stuart Halloway working first lab
stuarthalloway authored
1 # labrepl for Clojure
2
3 Copyright (c) Relevance, Inc. All rights reserved.
db97156 Stuart Halloway reorg README
stuarthalloway authored
4
c96dc78 Stuart Halloway rock-paper-scissors draft complete
stuarthalloway authored
5 The use and distribution terms for this software are covered by the
6 Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
7 which can be found in the file epl-v10.html at the root of this distribution.
8 By using this software in any fashion, you are agreeing to be bound by
9 the terms of this license.
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
10
db97156 Stuart Halloway reorg README
stuarthalloway authored
11 You must not remove this notice, or any other, from this software.
a471520 Alex Ott extended support for maven
alexott authored
12
9b00671 Stuart Halloway added overview section to README
stuarthalloway authored
13 # What is it?
14
15 Labrepl is an environment for exploring the Clojure language. It
16 includes:
17
18 * a web application that presents a set of lab exercises with
19 step-by-step instructions
20 * an interactive repl for working with the lab exercises
21 * solutions with passing tests
22 * up-to-date versions of Clojure, contrib, incanter, compojure and a bunch of other libraries to explore
23
24 See instructions below for getting started with NetBeans/Enclojure, Eclipse/Counterclockwise, Maven, Mac/Linux command line, Windows command line, IDEA/La Clojure, and Emacs.
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
25
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
26 ## Getting Started (NetBeans with Enclojure)
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
27
ce4adbd Mike Clark Updated NetBeans install steps.
clarkware authored
28 This is a one-time setup that does not require the git command line, Maven, or leiningen.
6ac98e2 Rich Hickey enhanced instructions for Netbeans
richhickey authored
29
a81cd74 Mike Clark Oops, fixed the formatting.
clarkware authored
30 * Install the Java SE version of [NetBeans](http://netbeans.org/downloads/index.html)
31 * Launch NetBeans
32 * If you've just installed NetBeans for the first time, make sure the Java SE plugin is
ce4adbd Mike Clark Updated NetBeans install steps.
clarkware authored
33 active
34 * Click the "Install Plugins" link on the Start page, then select the "Installed" tab or...
35 * Go to the Tools > Plugins menu, then select the "Installed" tab
a81cd74 Mike Clark Oops, fixed the formatting.
clarkware authored
36 * Download the [git plugin](http://nbgit.googlecode.com/files/nbgit-0.3.nbm)
37 * Download the [Enclojure plugin](http://github.com/downloads/EricThorsen/enclojure/enclojure-plugin-2010-23-mar.nbm)
38 * Install the git and Enclojure plugins
ce4adbd Mike Clark Updated NetBeans install steps.
clarkware authored
39 * Go to the Tools > Plugins menu, then select the "Downloaded" tab
40 * Click the "Add Plugins..." button and locate the downloaded .nbms files
41 * Click the "Install" button to complete the installation
a81cd74 Mike Clark Oops, fixed the formatting.
clarkware authored
42 * Restart NetBeans with the git and Enclojure plugins installed
43 * Clone the labrepl project from GitHub
ce4adbd Mike Clark Updated NetBeans install steps.
clarkware authored
44 * Go to the Team > Git > Clone Other menu
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
45 * For the Repository URL, use: git://github.com/relevance/labrepl.git
ce4adbd Mike Clark Updated NetBeans install steps.
clarkware authored
46 * Choose an arbitrary Parent Directory location where NetBeans will clone laprepl
a81cd74 Mike Clark Oops, fixed the formatting.
clarkware authored
47 * Open the labrepl project
ce4adbd Mike Clark Updated NetBeans install steps.
clarkware authored
48 * Use the File > Open Project menu and select the directory where you cloned labrepl
a81cd74 Mike Clark Oops, fixed the formatting.
clarkware authored
49 * Right click on "Libraries" in the project pane and select "Download Missing Dependencies"
ce4adbd Mike Clark Updated NetBeans install steps.
clarkware authored
50 * Wait for that to complete
6ac98e2 Rich Hickey enhanced instructions for Netbeans
richhickey authored
51
ce4adbd Mike Clark Updated NetBeans install steps.
clarkware authored
52 To run the labrepl:
6ac98e2 Rich Hickey enhanced instructions for Netbeans
richhickey authored
53
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
54 * Right click on the project in the project pane and select "Start Project REPL" (near the bottom)
55 * In the integrated REPL window, type:
6ac98e2 Rich Hickey enhanced instructions for Netbeans
richhickey authored
56 * `(require 'labrepl)`
57 * `(labrepl/-main)`
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
58 * Browse to http://localhost:8080
59 * Enjoy the labs!
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
60
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
61 ## Getting Started (Eclipse with Counterclockwise)
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
62
ce4adbd Mike Clark Updated NetBeans install steps.
clarkware authored
63 This is a one-time setup that does not require the git command line, Maven, or leiningen.
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
64
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
65 * Install [Eclipse](http://www.eclipse.org/downloads/)
66 * Download a recent version of "Eclipse IDE for Java Developers"
67 * Unzip it somewhere.
68 * The executable is eclipse (Linux), Eclipse (Mac), or eclipse.exe (Windows) located
69 in the eclipse/ directory created by the unzip operation
70 * Launch Eclipse
71 * The first time it is run, Eclipse will ask you for a location on your disk where
72 eclipse will put its metadata and will create new projects by default.
73 * Install the Eclipse Git (EGit) plugin
74 * Go to the Help > Install New Software menu
75 * For the "Work with:" site, use: http://download.eclipse.org/egit/updates
db97156 Stuart Halloway reorg README
stuarthalloway authored
76 * Hit Enter
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
77 * Expand the resulting "Eclipse Git Team Provider" set of features
78 * Select the "Eclipse EGit Feature"
79 * Verify the "Contact all update sites during ..." checkbox is checked
80 * Click "Next" and accept the license when prompted
81 * Click "Finish" to start the installation process
82 * When EGit has been installed, restart Eclipse
83 * Install the Maven (m2eclipse) plugin
84 * Go to the Help > Install New Software menu
85 * For the "Work with:" site, use: http://m2eclipse.sonatype.org/sites/m2e
db97156 Stuart Halloway reorg README
stuarthalloway authored
86 * Hit Enter
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
87 * Select "Maven Integration for Eclipse"
88 * Verify the "Contact all update sites during ..." checkbox is checked
89 * Click "Next" and accept the license when prompted
90 * Click "Finish" to start the installation process
91 * When Maven has been installed, restart Eclipse
92 * Install the Counterclockwise plugin
93 * Go to the Help > Install New Software menu
94 * For the "Work with:" site, use: http://updatesite.counterclockwise.googlecode.com/hg/
db97156 Stuart Halloway reorg README
stuarthalloway authored
95 * Hit Enter
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
96 * Select "Clojure Programming"
97 * Verify the "Contact all update sites during ..." checkbox is checked
98 * Click "Next" and accept the license when prompted
99 * Click "Finish" to start the installation process
100 * When Counterclockwise has been installed, restart Eclipse
101 * Clone the labrepl project from GitHub
102 * Go to File > Import ... > Git > Git Repository
103 * Hit Next
104 * For the "URI:", use: git://github.com/relevance/labrepl.git
105 * Hit Next twice
106 * Uncheck "Import Existing Projects" if prompted
107 * Hit "Select All" and hit "Finish"
108 * Import the labrepl Maven project into Eclipse
109 * Go to File > Import ... > Maven > Existing Maven Projects
110 * Hit Next
111 * Choose the root directory where you cloned the labrepl project in the previous step)
112 * Verify that the pom.xml file is selected
113 * Hit Finish
114 * Enable Clojure support
115 * Right-click the "labrepl" project in Package Explorer and choose "Enable/disable
116 clojure language support"
117
118 To run the labrepl:
119
120 * Right click on the project in the Package Explorer and select Run As > Clojure REPL
121 * In the REPL console, type:
db97156 Stuart Halloway reorg README
stuarthalloway authored
122 * `(require 'labrepl)`
123 * `(labrepl/-main)`
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
124 * Browse to http://localhost:8080
db97156 Stuart Halloway reorg README
stuarthalloway authored
125 * Enjoy the labs!
126
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
127 ## Getting Started (IntelliJ IDEA with La Clojure)
a2527d5 Stuart Halloway instructions for IntelliJ IDEA/La Clojure
stuarthalloway authored
128
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
129 This is a one-time setup that does not require the git command line, Maven, or leiningen.
a2527d5 Stuart Halloway instructions for IntelliJ IDEA/La Clojure
stuarthalloway authored
130
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
131 * Install [IntelliJ IDEA](http://www.jetbrains.com/idea/). The free Community Edition
132 works fine.
133 * Install the La Clojure plugin
134 * Go to File > Preferences
135 * Then open the Plugins preference and select the Available tab
136 * Select La Clojure, right-click it, and choose "Download and Install".
a2527d5 Stuart Halloway instructions for IntelliJ IDEA/La Clojure
stuarthalloway authored
137 * Restart IDEA.
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
138 * Clone the labrepl project from GitHub
139 * Go to Version Control > Checkout From Version Control > Git.
140 * Fill in the dialog with:
141 * Git Repository URL: git://github.com/relevance/labrepl.git
142 * Origin Name: (leave blank)
143 * Choose an arbitrary Parent Directory
a2527d5 Stuart Halloway instructions for IntelliJ IDEA/La Clojure
stuarthalloway authored
144 * Directory name: labrepl
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
145 * Hit the "Clone" button
146 * Choose "Yes" when prompted to create an IDEA project, and then select:
a2527d5 Stuart Halloway instructions for IntelliJ IDEA/La Clojure
stuarthalloway authored
147 * Import Project from external model
148 * Choose Maven if given choice of models
149 * Accept all the defaults (click "Next" a bunch of times.)
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
150 * Wait for Maven to download all the dependent libraries.
a2527d5 Stuart Halloway instructions for IntelliJ IDEA/La Clojure
stuarthalloway authored
151
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
152 To run the labrepl:
a2527d5 Stuart Halloway instructions for IntelliJ IDEA/La Clojure
stuarthalloway authored
153
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
154 * Choose Tools > Clojure REPL > Add New Clojure REPL
a2527d5 Stuart Halloway instructions for IntelliJ IDEA/La Clojure
stuarthalloway authored
155 * In the REPL Console
156 * `(require 'labrepl)`
157 * `(labrepl/-main)`
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
158 * Browse to http://localhost:8080
a2527d5 Stuart Halloway instructions for IntelliJ IDEA/La Clojure
stuarthalloway authored
159 * Enjoy the labs!
160
db97156 Stuart Halloway reorg README
stuarthalloway authored
161 ## Getting Started (Maven)
162
163 * Make sure you have Java installed.
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
164 * Make sure you have [Maven](http://maven.apache.org/) installed.
165 * Clone the labrepl project and change directory into it.
166 * Run `mvn clojure:repl` to launch Clojure REPL (Maven will download all necessary
db97156 Stuart Halloway reorg README
stuarthalloway authored
167 dependencies).
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
168 * Browse to http://localhost:8080 for the labs.
db97156 Stuart Halloway reorg README
stuarthalloway authored
169 * Press Ctrl+D to exit the repl when you are done.
170
171 ## Getting Started (Mac/Linux command line)
172
173 * Make sure you have Java installed.
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
174 * Make sure you have [leiningen](http://github.com/technomancy/leiningen) installed.
175 * Clone the labrepl project and change directory into it.
176 * Run `lein deps` to install all the dependent libraries.
db97156 Stuart Halloway reorg README
stuarthalloway authored
177 * Run `script/repl` to launch the labrepl.
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
178 * Browse to http://localhost:8080 for the labs.
db97156 Stuart Halloway reorg README
stuarthalloway authored
179 * Press Ctrl+D to exit the repl when you are done.
180
181 ## Getting Started (Windows command line)
182
183 This is minimally tested. You are probably better off using Maven or one of the IDEs above. Let me know if you have problems.
184
185 * Make sure you have Java installed.
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
186 * Make sure you have [leiningen](http://github.com/technomancy/leiningen) installed. Do not use `lein self-install` as Windows installation is a manual process. You will need to:
187 * Download the leinigen.jar and set `LEIN_JAR` to point to it.
188 * Download [Clojure 1.1](http://code.google.com/p/clojure/downloads/list)
189 * Set `CLOJURE_JAR` to point to the clojure.jar file.
db97156 Stuart Halloway reorg README
stuarthalloway authored
190 * Set your path to include `{your-lein-install}\bin`
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
191 * Run `lein.bat deps` to install all the dependent libraries.
db97156 Stuart Halloway reorg README
stuarthalloway authored
192 * Run `script\repl` to launch the labrepl.
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
193 * Browse to http://localhost:8080 for the labs.
db97156 Stuart Halloway reorg README
stuarthalloway authored
194 * Press Ctrl+D to exit the repl when you are done.
195
196 ## Getting Started (Emacs)
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
197
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
198 If you don't know Emacs, you may want to pick one of the choices above. The learning curve here is steep.
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
199
db97156 Stuart Halloway reorg README
stuarthalloway authored
200 * Install Emacs, the Emacs Starter Kit, Clojure mode, slime, and swank.
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
201 * From within emacs, set the `inferior-lisp-program` variable to `script/swank`.
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
202 * Making sure your Emacs working directory is the labrepl, run `inferior-lisp`.
488ac7d Stuart Halloway update readme, commit pom
stuarthalloway authored
203 * If you want slime as well, run `slime-connect` and accept the defaults. You now have slime and inferior-lisp both working simultaneously.
204
db97156 Stuart Halloway reorg README
stuarthalloway authored
205 ## Running the Tests
45d389d Stuart Halloway instructions for running the tests
stuarthalloway authored
206
db97156 Stuart Halloway reorg README
stuarthalloway authored
207 * Maven: `mvn clojure:test`
208 * Shell: `script/test`
45d389d Stuart Halloway instructions for running the tests
stuarthalloway authored
209
db97156 Stuart Halloway reorg README
stuarthalloway authored
210 ## Thanks for contributions and reviews from
c374fd4 Stuart Halloway LJK feedback
stuarthalloway authored
211
96b492f Stuart Halloway license
stuarthalloway authored
212 * Aaron Bedra
39ec1d1 Mike Clark Tested and updated steps for all other IDEs.
clarkware authored
213 * Mike Clark
9b00671 Stuart Halloway added overview section to README
stuarthalloway authored
214 * Daniel Solano Gómez
d37fd85 Stuart Halloway new lab: looping
stuarthalloway authored
215 * Rich Hickey
eb4644a Stuart Halloway thanks Shawn Hoover for windows improvements
stuarthalloway authored
216 * Shawn Hoover
c374fd4 Stuart Halloway LJK feedback
stuarthalloway authored
217 * Larry Karnowski
d37fd85 Stuart Halloway new lab: looping
stuarthalloway authored
218 * Michael Kohl
96b492f Stuart Halloway license
stuarthalloway authored
219 * Jess Martin
d37fd85 Stuart Halloway new lab: looping
stuarthalloway authored
220 * Alex Ott
db97156 Stuart Halloway reorg README
stuarthalloway authored
221 * Laurent Petit
9b00671 Stuart Halloway added overview section to README
stuarthalloway authored
222 * Seth Schroeder
96b492f Stuart Halloway license
stuarthalloway authored
223
45d389d Stuart Halloway instructions for running the tests
stuarthalloway authored
224
624832e Stuart Halloway working first lab
stuarthalloway authored
225
Something went wrong with that request. Please try again.